Відділи

Повертає перелік відділів організації — постійний довідник, до якого прив'язані співробітники та графіки.

Скоуп

Скоуп не потрібен — ендпоінт доступний будь-якому валідному ключу організації. Детальніше — у Скоупах і правах.

Query-параметри

Параметр Обов'язковий Опис
limit ні Ціле 1..200, за замовчуванням 100.
cursor ні Курсор meta.next_cursor попередньої відповіді — для наступної сторінки.

department_id і employee_id на цьому ресурсі не підтримані: якщо передати будь-який з них, відповідь — 400 validation_error (параметр відхиляється явно, а не ігнорується мовчки — див. Конвенції → Фільтри). У відділів також немає from/to — це ресурс без часово́го виміру.

Запит

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

Відповідь

{
  "data": [
    {
      "id": "9c1a2e34-5678-4abc-9def-0123456789ab",
      "name": "Кухня",
      "parent_id": null,
      "sort_order": 0,
      "color": "#f97316",
      "geo": null
    },
    {
      "id": "3f7b1c9a-2d4e-4a11-8b6f-5e0d9c2a7f31",
      "name": "Зал",
      "parent_id": null,
      "sort_order": 1,
      "color": null,
      "geo": null
    }
  ],
  "meta": { "next_cursor": null }
}

Поля відповіді

Поле Тип Опис
id string (uuid) Унікальний ідентифікатор відділу.
name string Назва відділу.
parent_id string (uuid) | null Батьківський відділ, якщо відділи вкладені; null для відділу верхнього рівня.
sort_order number Порядковий номер відділу в списку; список відсортований за цим полем (плюс id як тай-брейкер).
color string | null Hex-колір відділу (наприклад, #f97316), яким він підсвічується в графіку; null, якщо колір не заданий.
geo string | null Довільний текст з точкою/локацією відділу; null, якщо не заданий.

Пагінація

Список відсортований за sort_order, id. Якщо рядків більше, ніж limit, meta.next_cursor містить курсор для наступної сторінки; передайте його в cursor наступного запиту як є — без розкодування:

curl -s "https://smengo.com/api/v1/departments?limit=1&cursor=eyJrIjoxLCJpZCI6IjljMWEyZTM0LTU2NzgtNGFiYy05ZGVmLTAxMjM0NTY3ODlhYiJ9" \
  -H "Authorization: Bearer smg_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

meta.next_cursor дорівнює null, коли відділів більше немає. Загальні правила пагінації — у Конвенціях → Пагінація.

Що далі

  • Організація — дані організації, включно з таймзоною.
  • Співробітники — у кожного співробітника є department_id, що посилається на відділ з цього списку.
  • Конвенції — формат відповідей і фільтри.
Чи була стаття корисною?