Получает несколько пользователей

  1. HTTP-запрос
  2. Path-параметры
  3. Query-параметры
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
    3. Код 403
    4. Код 422

Получает список пользователей в компании.

HTTP-запрос

GET https://courier.yandex.ru/api/v1/companies/{company_id}/users\
?page={integer}

Path-параметры

company_id *

integer

ID компании, используемый в запросах к API Мониторинга.

company_id *

integer

ID компании, используемый в запросах к API Мониторинга.

Query-параметры

page

integer

Номер страницы в базе данных. Каждая страница содержит 1000 пользователей, организованных в порядке возрастания ID пользователя.

Минимальное значение: 1.
Значение по умолчанию: 1.

page

integer

Номер страницы в базе данных. Каждая страница содержит 1000 пользователей, организованных в порядке возрастания ID пользователя.

Минимальное значение: 1.
Значение по умолчанию: 1.

Ответы

Код 200

Возвращает список пользователей в компании.

[
  {
    "id": integer,
    "login": string,
    "role": string
  }
]
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

id

integer

ID пользователя.

login *

string

Логин пользователя.

role

string

Роль пользователя. Возможные значения: admin, manager, dispatcher, app.

id

integer

ID пользователя.

login *

string

Логин пользователя.

role

string

Роль пользователя. Возможные значения: admin, manager, dispatcher, app.

Код 401

Ошибка авторизации. Отправьте правильный OAuth-токен в заголовке авторизации.

Код 403

У вас нет доступа к этому объекту.

Код 422

Неправильный ввод.