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

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": "string"
    }
]

ListOfUsers[]

ListOfUsers

Name

Description

id

Type: integer

User ID.

login

Type: string

User's login.

role

Type: string

Role of this user. Possible values: admin, manager, dispatcher, app.

401 Unauthorized

Deprecated

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

403 Forbidden

Deprecated

You do not have access to this object.

422 Unprocessable Entity

Deprecated

Incorrect input.