Gets multiple users

  1. HTTP Request
  2. Path Parameters
  3. Query Parameters
  4. Responses
    1. Code 200
      1. Representation
      2. Fields
    2. Code 401
    3. Code 403
    4. Code 422

Gets a list of users in the company.

HTTP Request

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

Path Parameters

company_id *

integer

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

company_id *

integer

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

Query Parameters

page

integer

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

Minimum value: 1.
Default value: 1.

page

integer

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

Minimum value: 1.
Default value: 1.

Responses

Code 200

Returns a list of users in the company.

[
  {
    "id": integer,
    "login": string,
    "role": string
  }
]
Copied to clipboard

Representation

Collapse all
Expand all

Fields

id

integer

User ID.

login

string

User's login.

role

string

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

id

integer

User ID.

login

string

User's login.

role

string

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

Code 401

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

Code 403

You do not have access to this object.

Code 422

Incorrect input.