SmengoAPI

Быстрый старт

Всё, что нужно для первого запроса, — действующий API-ключ (см. Аутентификацию).

Запрос

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

Этот эндпоинт требует скоуп employees.read — без него ключ получит 403 missing_scope.

Ответ

{
  "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 }
}

Поля ответа

  • id — уникальный идентификатор сотрудника.
  • full_name — полное имя; список отсортирован по этому полю (плюс id как тай-брейкер).
  • position — должность, может быть пустой.
  • department_id — отдел сотрудника (см. GET /departments), может быть пустым.
  • employment_kind — тип занятости: staff или trainee.
  • status — вычисляемый статус доступа: active или access_revoked.
  • created_at, updated_at — время создания и последнего изменения записи, ISO 8601 UTC.

meta.next_cursor — курсор для следующей страницы результатов; null, если сотрудников больше нет. Полное описание пагинации — в Конвенциях.

Что дальше

Была ли статья полезна?