Gets multiple users

Gets a list of users in the company.

Request

GET

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

Path parameters

Name

Description

company_id*

Type: integer<int64>

The ID of the company that is used in requests to the Track & Trace API.

Query parameters

Name

Description

page

Type: integer

Database page number. Each page holds 1000 entities in ascending order.

Default: 1

Min value: 1

Responses

200 OK

Returns a list of users in the company.

Body

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

ListOfUsers[]

ListOfUsers

Name

Description

id

Type: integer

User ID.

login

Type: string

User's login.

role

Type: string

Role of this user in the company. Possible values: yandex_staff, admin, manager, dispatcher, app.

Enum: yandex_staff, admin, manager, dispatcher, app

role_end_time

Type: integer<int64>

UNIX timestamp when the role gets revoked.

Min value: 0

401 Unauthorized

Authorization failed. Send the correct OAuth token in the authorization header.

403 Forbidden

You do not have access to this object.

422 Unprocessable Entity

Incorrect input.

No longer supported, please use an alternative and newer version.