Швидкий старт
Усе, що потрібно для першого запиту, — дійсний 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, якщо співробітників більше немає. Повний опис пагінації — у Конвенціях.
Що далі
- Конвенції API — формат відповідей, помилки, пагінація, фільтри.
- Довідник скоупів — які права потрібні для кожного ресурсу.
- Довідник ендпоінтів → Співробітники — усі поля та фільтри ресурсу.
Чи була стаття корисною?