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

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

Request

GET

https://courier.yandex.ru/api/v1/companies/{company_id}/users

Path parameters

Name

Description

company_id*

Type: integer

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

Query parameters

Name

Description

page

Type: integer

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

Default: 1

Min value: 1

Responses

200 OK

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

Body

application/json
[
    {
        "id": 0,
        "login": "string",
        "role": "string"
    }
]

ListOfUsers[]

ListOfUsers

Name

Description

id

Type: integer

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

login

Type: string

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

role

Type: string

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

401 Unauthorized

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

403 Forbidden

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

422 Unprocessable Entity

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