Метод GET /openapi/v1/groups

19 апреля 2024

ID 242751

Получение списка групп, доступных для данной компании.

Запрос

Заголовок:

  • Authorization – API-токен компании.

Ответ

  • total – тип number – число доступных групп в компании.
  • result – тип array – массив из объектов с данными доступных групп.
    • id – тип string – идентификатор группы.
    • name – тип string – название группы.
    • isStarted – тип boolean – запущено ли обучение в группе.

Пример ответа:

{

    total: 1,

    result: [{

        id: '627d5c63f0672a10fbac23bb',

        name: 'Low risk',

        isStarted: true

    }]

}

Возможные ошибки:

  • 401common-unauthorized – ошибка авторизации.
  • 404groups-not-found – для компании по данному токену группы не найдены.
  • 429too-many-requests – превышено ограничение на количество запросов.
  • 500internal-server-error – внутренняя ошибка сервера.

Вам помогла эта статья?
Что нам нужно улучшить?
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!