Getting list of driver profiles (couriers)

Returns a list of driver (courier) profiles associated with a given partner. It is the recommended method for obtaining profiles. The platform also supports pagination and filtering. The platform allows obtaining the following:

all driver (courier) profiles;
all driver (courier) profiles with the given status and working conditions;
driver (courier) profiles selected by ID.

Request

POST

https://fleet-api.taxi.yandex.net/v1/parks/driver-profiles/list

Headers

Name	Description
Accept-Language*	Type: string Preferred language of the response Example: `ru` Min length: `2`
X-API-Key*	Type: string API-key Example: `<API key>` Min length: `1`
X-Client-ID*	Type: string Client ID Example: `<Client ID>` Min length: `1`

Body

application/json

{
    "query": {
        "park": {
            "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
            "driver_profile": {
                "id": [
                    "2111ade6gk054dfdb9iu8c8cc9460mks"
                ],
                "work_rule_id": [
                    "bc43tre6ba054dfdb7143ckfgvcby63e"
                ],
                "work_status": [
                    "working"
                ]
            },
            "current_status": {
                "status": [
                    "free"
                ]
            },
            "account": {
                "last_transaction_date": {
                    "from": "2022-12-29T18:02:01Z",
                    "to": "2022-12-29T18:02:01Z"
                }
            },
            "updated_at": {
                "from": "2022-12-29T18:02:01Z",
                "to": "2022-12-29T18:02:01Z"
            }
        },
        "text": "string"
    },
    "fields": {
        "account": [
            "balance"
        ],
        "car": [
            "color"
        ],
        "current_status": [
            "status"
        ],
        "driver_profile": [
            "last_name"
        ],
        "park": [
            "name"
        ],
        "updated_at": false
    },
    "sort_order": [
        {
            "direction": "asc",
            "field": "driver_profile.created_date"
        }
    ],
    "limit": 200,
    "offset": 0
}

Name	Description
query*	Type: DriverProfilesListRequestQuery Filters can be merged using logical "AND"
fields	Type: DriverProfileListRequestFields Profile fields to be retrieved. When empty, all profile fields are retrieved. To exclude a specific block of fields, pass an empty array for the corresponding section. E.g. specify `"car": []` if you want to exclude vehicle information. Example: `"fields": { "car": [], "park": [], "driver_profile": [ "first_name", "last_name", "id" ], "account": [ "id", "balance", "balance_limit", "currency" ] }`
limit	Type: integer<int32> Number of list items being requested Default: `1000` Example: `200` Min value: `1` Max value: `1000`
offset	Type: integer<int32> Offset from the beginning of the list Default: `0` Example: `0` Min value: `0`
sort_order	Type: DriverProfileRequestSortOrderField[] An array of fields to define profiles order in the response

DriverProfilesListRequestQuery

Filters can be merged using logical "AND"

Name

Description

park

Type: DriverProfilesListRequestQueryPark

Partner parameters

text

Type: string

Arbitrary full-text search request

DriverProfileListRequestFields

Profile fields to be retrieved. When empty, all profile fields are retrieved. To exclude a specific block of fields, pass an empty array for the corresponding section. E.g. specify "car": [] if you want to exclude vehicle information. Example:

"fields": {
    "car": [],
    "park": [],
    "driver_profile": [
        "first_name",
        "last_name",
        "id"
    ],
    "account": [
        "id",
        "balance",
        "balance_limit",
        "currency"
    ]
}

Name	Description
account	Type: string[] Account data to be retrieved. Possible values: `id` — account ID; `type` — account type; `balance` — current account balance; `balance_limit` — current limit; `currency` — currency code as per ISO 4217. `last_transaction_date` — date of the last transaction Example: `balance`
car	Type: VehicleField[] Vehicle data to be retrieved. Possible values: `id` — identifier; `status` — status; `amenities` — services; `category` — categories; `callsign` — codename; `brand` — make; `model` — current model; `year` — year of manufacture; `color` — color; `number` — registration number; `registration_cert` — vehicle registration certificate; `vin` — vehicle identification number (VIN). Vehicle field Example: `color` Enum: `id`, `status`, `amenities`, `category`, `callsign`, `brand`, `model`, `year`, `color`, `number`, `registration_cert`, `vin`
current_status	Type: string[] Driver state data to be retrieved. Possible values: `status` — driver's current state; `status_updated_at` — time of the most recent driver's current state update. Example: `status`
driver_profile	Type: string[] Driver profile data to be retrieved. Possible values: `id` — driver's profile ID; `park_id` — partner ID; `created_date` — date when the profile is created ISO 8601; `first_name` — first name; `last_name` — last name; `middle_name` — middle name; `driver_license` — information about a driver's license; `phones` — phone numbers; `work_rule_id` — working condition ID; `work_status` — driver's working status; `check_message` — feedback on a driver; `comment` — other; `employment_type` - driver's employment type `has_contract_issue` - there are problems with confirming employment. Example: `last_name`
park	Type: string[] Partner data to be retrieved. Possible values: `id` — partner ID; `city` — city where the partner is located; `name` — name of a partner. Example: `name`
updated_at	Type: boolean Whether to return time of latest update

DriverProfileRequestSortOrderField

Name

Description

direction*

Type: string

Sorting direction. Possible values:

asc — ascending sorting;
desc — descending sorting.

Example: asc

Enum: asc, desc

field*

Type: string

Field used to sort the values. Possible values:

account.current.balance — balance;
driver_profile.created_date — date of driver's profile creation;
driver_profile.last_name — last name in the driver's profile;
driver_profile.first_name — name in the driver's profile;
driver_profile.middle_name — middle name in the driver's profile;
updated_at - time of latest update.

Example: driver_profile.created_date

Enum: account.current.balance, driver_profile.created_date, driver_profile.last_name, driver_profile.first_name, driver_profile.middle_name, updated_at

DriverProfilesListRequestQueryPark

Partner parameters

Name	Description
id*	Type: string Partner ID Example: `ee6f33c4562b4e1f8646d157bd70b2c4`
account	Type: DriverProfilesListRequestQueryParkAccount Filters by account data
current_status	Type: DriverProfilesListRequestQueryParkCurrentStatus Filter by driver's current state
driver_profile	Type: DriverProfilesListRequestQueryParkDriverProfile Filters by driver profile data
updated_at	Type: DriverProfilesListRequestQueryParkUpdatedAt Filters by time of latest update; Half-interval for which a start or end point must be indicated

VehicleField

Vehicle field

Type

Description

VehicleField

Example: color

Enum: id, status, amenities, category, callsign, brand, model, year, color, number, registration_cert, vin

DriverProfilesListRequestQueryParkAccount

Filters by account data

Name

Description

last_transaction_date

Type: DriverProfilesListRequestQueryParkAccountLastTransactionDate

Half-interval for which a start or end point must be indicated

DriverProfilesListRequestQueryParkCurrentStatus

Filter by driver's current state

Name

Description

status*

Type: DriverStatus[]

Driver's current state. Possible values:

offline — offline;
busy — busy;
free — available;
in_order_free - is on the ride now, available (stacked rides enabled);
in_order_busy — is on the ride now, busy (stacked rides disabled).

Example: free

Enum: offline, busy, free, in_order_free, in_order_busy

DriverProfilesListRequestQueryParkDriverProfile

Filters by driver profile data

Name	Description
id	Type: string[] Driver's profile ID Example: `2111ade6gk054dfdb9iu8c8cc9460mks`
work_rule_id	Type: string[] Work rule ID Example: `bc43tre6ba054dfdb7143ckfgvcby63e`
work_status	Type: WorkStatus[] Driver's working status. Possible values: `working` — "Is working" status. `not_working` — "Not working" status; `fired` — status for dismissed drivers; Example: `working` Enum: `working`, `not_working`, `fired`

DriverProfilesListRequestQueryParkUpdatedAt

Filters by time of latest update; Half-interval for which a start or end point must be indicated

Name

Description

from

Type: string<date-time>

Start time as per ISO 8601

Type: string<date-time>

End time as per ISO 8601

DriverProfilesListRequestQueryParkAccountLastTransactionDate

Half-interval for which a start or end point must be indicated

Name

Description

from

Type: string<date-time>

Start time as per ISO 8601

Type: string<date-time>

End time as per ISO 8601

DriverStatus

Driver's current state. Possible values:

offline — offline;
busy — busy;
free — available;
in_order_free - is on the ride now, available (stacked rides enabled);
in_order_busy — is on the ride now, busy (stacked rides disabled).

Type

Description

DriverStatus

Example: free

Enum: offline, busy, free, in_order_free, in_order_busy

WorkStatus

Driver's working status. Possible values:

working — "Is working" status.
not_working — "Not working" status;
fired — status for dismissed drivers;

Type

Description

WorkStatus

Example: working

Enum: working, not_working, fired

Responses

200 OK

List of driver profiles was received successfully

Body

application/json

{
    "limit": 200,
    "offset": 0,
    "total": 728,
    "driver_profiles": [
        {
            "accounts": [
                {
                    "id": "33de650c6a1a40bfa78dd981817da866",
                    "type": "current",
                    "balance": "700.0000",
                    "balance_limit": "50",
                    "currency": "RUB"
                }
            ],
            "car": {
                "id": "2111ade6gk054dfdb9iu8c8cc9460mks",
                "status": "working",
                "amenities": [
                    [
                        "wifi"
                    ]
                ],
                "category": [
                    [
                        "econom"
                    ]
                ],
                "callsign": "123456789",
                "brand": "Mercedes-Benz",
                "model": "E-klasse",
                "year": 2019,
                "color": "Черный",
                "number": "Т8654Т99",
                "registration_cert": "123456789",
                "vin": "12345678909876543"
            },
            "current_status": {
                "status": "free",
                "status_updated_at": "2020-04-27T08:44:05.871+0000"
            },
            "driver_profile": {
                "id": "2111ade6gk054dfdb9iu8c8cc9460mks",
                "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4",
                "created_date": "2020-04-23T13:08:05.552+0000",
                "last_name": "Ivanov",
                "first_name": "Ivan",
                "middle_name": "Ivanovich",
                "driver_license": {
                    "issue_date": "2020-10-28",
                    "expiration_date": "2050-10-28",
                    "number": "070236",
                    "normalized_number": "AA00123456",
                    "country": "rus",
                    "birth_date": "1975-10-28"
                },
                "phones": [
                    "+79999999999"
                ],
                "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e",
                "work_status": "working",
                "check_message": "great driver",
                "comment": "great driver",
                "employment_type": "selfemployed",
                "has_contract_issue": false
            }
        }
    ],
    "parks": [
        {
            "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
            "city": "Tel Aviv",
            "name": "Mickey Mouse Company"
        }
    ]
}

Name	Description
driver_profiles*	Type: DriverProfile[] List of profiles
limit*	Type: integer<int32> Requested number of list items Example: `200`
offset*	Type: integer<int32> Requested offset from the beginning of the list Example: `0`
parks*	Type: DriverProfilePark[] List of partners
total*	Type: integer<int32> Total number of list items Example: `728`

DriverProfile

Name	Description
accounts	Type: DriverProfileAccount[] List of accounts associated with the driver Account information
car	Type: Vehicle Vehicle data
current_status	Type: DriverProfileCurrentStatus
driver_profile	Type: DriverProfileModel Driver profile

DriverProfilePark

Name	Description
city	Type: string City where the partner operates Example: `Tel Aviv`
id	Type: string Partner ID Example: `ee6f33c4562b4e1f8646d157bd70b2c4`
name	Type: string Partner name Example: `Mickey Mouse Company`

DriverProfileAccount

Account information

Name	Description
balance	Type: string Current account balance (fixed-point sum) Example: `700.0000`
balance_limit	Type: string Balance limit Example: `50`
currency	Type: string Currency as per ISO 4217 Example: `RUB`
id	Type: string Account ID Example: `33de650c6a1a40bfa78dd981817da866`
type	Type: AccountType Account type. Possible values: `current` — current account. Example: `current` Enum: `current`

Vehicle

Vehicle data

Name	Description
id*	Type: string Vehicle ID Example: `2111ade6gk054dfdb9iu8c8cc9460mks`
amenities	Type: string[] Vehilce amenity. Possible values: `conditioner` `no_smoking` `child_chair` `animal_transport` `universal` `wifi` `check` `card` `yamoney` `newspaper` `coupon` `creditcard` `dont_call` `smoking` `delivery` `vip_event` `woman_driver` `post_terminal` `bicycle` `skiing` `passenger_plus` `cargo_clean` `door_to_door` `sticker` `lightbox` Example: `[ "wifi" ]` Enum: `conditioner`, `no_smoking`, `child_chair`, `animal_transport`, `universal`, `wifi`, `check`, `card`, `yamoney`, `newspaper`, `coupon`, `creditcard`, `dont_call`, `smoking`, `delivery`, `vip_event`, `woman_driver`, `post_terminal`, `bicycle`, `skiing`, `passenger_plus`, `cargo_clean`, `door_to_door`, `sticker`, `lightbox`
brand	Type: string Vehicle make Example: `Mercedes-Benz`
callsign	Type: string Vehicle code name (short name) Example: `123456789`
category	Type: string[] List of vehicle categories. Possible values: `econom` — Economy class; `comfort` — Comfort; `comfort_plus` — Comfort+; `business` — business class vehicle; `minivan` — minivan; `vip` — A VIP class vehicle; `wagon` — multi-purpose; `pool` — pool class vehicle; `start` — Start class vehicle; `standart` — Standart class vehicle; `ultimate` — Premier; `maybach` — elite class vehicle; `promo` — promotion; `premium_van` — cruise van; `premium_suv` — premium SUV; `suv` — SUV; `personal_driver` — personal driver class vehicle; `express` — delivery class vehicle; `cargo` — a cargo vehicle. Example: `[ "econom" ]` Enum: `econom`, `comfort`, `comfort_plus`, `business`, `minivan`, `vip`, `wagon`, `pool`, `start`, `standart`, `ultimate`, `maybach`, `promo`, `premium_van`, `premium_suv`, `suv`, `personal_driver`, `express`, `cargo`
color	Type: ColorEnum Vehicle color. Possible values: `Белый` — White; `Желтый` — Yellow; `Бежевый` — Beige; `Черный` — Black; `Голубой` — Light blue; `Серый` — Gray; `Красный` — Red; `Оранжевый` — Orange; `Синий` — Dark blue; `Зеленый` — Green; `Коричневый` — Brown; `Фиолетовый` — Purple; `Розовый` — Pink. Example: `Черный` Enum: `Белый`, `Желтый`, `Бежевый`, `Черный`, `Голубой`, `Серый`, `Красный`, `Оранжевый`, `Синий`, `Зеленый`, `Коричневый`, `Фиолетовый`, `Розовый`
model	Type: string Vehicle model Example: `E-klasse`
number	Type: string License plate number Example: `Т8654Т99`
registration_cert	Type: string Vehicle registration certificate (Required field for Russia) Example: `123456789`
status	Type: string Vehicle status. Currently possible values: `unknown` — status is unknown; `working` — is used at the moment to complete trips; `not_working` — is not used at the moment to complete trips; `repairing` — is undergoing technical maintenance or repair works; `no_driver` - no driver assigned to a vehicle; `pending` - vehicle details processing is in progress. Example: `working`
vin	Type: string VIN (Required field for Russia) Example: `12345678909876543`
year	Type: integer Year of vehicle manufacture Example: `2019`

DriverProfileCurrentStatus

Name

Description

status

Type: DriverStatus

Driver's current state. Possible values:

offline — offline;
busy — busy;
free — available;
in_order_free - is on the ride now, available (stacked rides enabled);
in_order_busy — is on the ride now, busy (stacked rides disabled).

Example: free

Enum: offline, busy, free, in_order_free, in_order_busy

status_updated_at

Type: string

Time of the last update of the current driver status in the ISO 8601 format.

Example: 2020-04-27T08:44:05.871+0000

DriverProfileModel

Driver profile

Name

Description

check_message

Type: string

Notes (available to park employees)

Example: great driver

comment

Type: string

Notes

Example: great driver

created_date

Type: string

Date of profile creation as per ISO 8601

Example: 2020-04-23T13:08:05.552+0000

driver_license

Type: object

country*	Type: string Country of issue (Three-letter code) Example: `rus`
normalized_number*	Type: string Normalized series and number (Cyrillic letters have been replaced by Latin letters) Example: `AA00123456`
number*	Type: string Driver's license series and number Example: `070236`
birth_date	Type: string Birth date in ISO 8601 format without time zone Example: `1975-10-28`
expiration_date	Type: string Driver's license expiry date in ISO 8601 format without time zone Example: `2050-10-28`
issue_date	Type: string Date of issue of the driver's license in ISO 8601 format without time zone Example: `2020-10-28`

Driver's license

employment_type

Type: EmploymentType

Driver's employment type. Possible values:

selfemployed — Self-employed;
park_employee — Park employee;
individual_entrepreneur — Individual entrepreneur;

Example: selfemployed

Enum: selfemployed, park_employee, individual_entrepreneur

first_name

Type: string

Name

Example: Ivan

has_contract_issue

Type: boolean

There are problems with confirming employment

Type: string

Driver's profile ID

Example: 2111ade6gk054dfdb9iu8c8cc9460mks

last_name

Type: string

Last name

Example: Ivanov

middle_name

Type: string

Middle name

Example: Ivanovich

park_id

Type: string

Partner ID

Example: ee6f33c4562b4e1f8646d157bd70b2c4

phones

Type: string[]

Phone number

Example: +79999999999

Pattern: ^\+\d{1,15}$

work_rule_id

Type: string

Work rule ID

Example: bc43tre6ba054dfdb7143ckfgvcby63e

work_status

Type: WorkStatus

Driver's working status. Possible values:

working — "Is working" status.
not_working — "Not working" status;
fired — status for dismissed drivers;

Example: working

Enum: working, not_working, fired

AccountType

Account type. Possible values:

current — current account.

Type

Description

AccountType

Example: current

Enum: current

ColorEnum

Vehicle color. Possible values:

Белый — White;
Желтый — Yellow;
Бежевый — Beige;
Черный — Black;
Голубой — Light blue;
Серый — Gray;
Красный — Red;
Оранжевый — Orange;
Синий — Dark blue;
Зеленый — Green;
Коричневый — Brown;
Фиолетовый — Purple;
Розовый — Pink.

Type

Description

ColorEnum

Example: Черный

Enum: Белый, Желтый, Бежевый, Черный, Голубой, Серый, Красный, Оранжевый, Синий, Зеленый, Коричневый, Фиолетовый, Розовый

EmploymentType

Driver's employment type. Possible values:

selfemployed — Self-employed;
park_employee — Park employee;
individual_entrepreneur — Individual entrepreneur;

Type

Description

EmploymentType

Example: selfemployed

Enum: selfemployed, park_employee, individual_entrepreneur

400 Bad Request

Invalid request parameters

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

401 Unauthorized

Request authorization parameters are missing

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

403 Forbidden

Insufficient rights to execute the request

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

429 Too Many Requests

Limit of requests was exceeded

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

500 Internal Server Error

Internal server error

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

Was the article helpful?

Binding car to driver (courier)

Create contractor profile with indication of partnership type