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.

Что дальше

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