SmengoAPI

Quick start

All you need for a first request is a valid API key (see Authentication).

Request

curl -s https://smengo.com/api/v1/employees \
  -H "Authorization: Bearer smg_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

This endpoint requires the employees.read scope — without it, the key gets 403 missing_scope.

Response

{
  "data": [
    {
      "id": "5e6d9f2a-3b7c-4e2f-9a1d-7c8e2f6b4a10",
      "full_name": "Иванова Мария",
      "position": "Бариста",
      "department_id": "9c1a2e34-5678-4abc-9def-0123456789ab",
      "employment_kind": "staff",
      "status": "active",
      "created_at": "2026-03-01T09:00:00.000Z",
      "updated_at": "2026-07-01T12:00:00.000Z"
    }
  ],
  "meta": { "next_cursor": null }
}

Response fields

  • id — the employee's unique identifier.
  • full_name — full name; the list is sorted by this field (plus id as a tiebreaker).
  • position — job title, may be empty.
  • department_id — the employee's department (see GET /departments); may be empty.
  • employment_kind — employment type: staff or trainee.
  • status — a computed access status: active or access_revoked.
  • created_at, updated_at — when the record was created and last updated, ISO 8601 UTC.

meta.next_cursor — the cursor for the next page of results; null when there are no more employees. Pagination is fully documented in Conventions.

What's next

Was this article helpful?