SmengoAPI

Організація

Повертає дані про організацію, до якої належить API-ключ. Це єдиний ендпоінт API v1, який віддає не список, а одиночний об'єкт — в організації, прив'язаної до ключа, завжди рівно один запис.

Скоуп

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

Запит

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

Параметрів запиту немає — ні фільтрів, ні пагінації: GET /org завжди повертає той самий об'єкт для цього ключа.

Відповідь

Одиночний об'єкт без meta (див. Конвенції → Формат відповіді):

{
  "data": {
    "name": "Coffee & Co",
    "slug": "coffee-co",
    "timezone": "Europe/Kyiv",
    "default_locale": "ru"
  }
}

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

Поле Тип Опис
name string Назва організації, як вона задана в налаштуваннях Smengo.
slug string Короткий унікальний ідентифікатор організації.
timezone string IANA-таймзона організації (наприклад, Europe/Kyiv). Саме вона використовується для полів-днів (from, to, entry_date тощо) у решті ендпоінтів API — див. Конвенції → Дати та час.
default_locale string Локаль організації за замовчуванням: ru, uk або en.

Що далі

Чи була стаття корисною?