Getting a list of contractor applications from the garage

Getting a list of contractor applications from the garage with pagination

Request

GET

https://fleet-api.taxi.yandex.net/v1/parks/contractors/applications/list

Query parameters

Name	Description
cursor	Type: string Cursor for obtaining the next data chunk Example: `eyJsZWFkX2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAwIn0=`
date_start	Type: string<date-time> Start date for filtering by last booking time in ISO 8601. Can be passed on the first page only (without cursor). Example: `2026-01-01T10:00:00Z`
limit	Type: integer Limit of elements in response Default: `100` Min value: `1` Max value: `100`

Headers

Name	Description
X-API-Key	Type: string API-key Min length: `1` Example: `<API key>`
X-Client-ID	Type: string Client ID Min length: `1` Example: `<Client ID>`
X-Park-ID	Type: string Partner ID Example: `ee6f33c4562b4e1f8646d157bd70b2c4`
Accept-Language	Type: string Preferred language of the response. Defaults to ru if not specified. Min length: `2` Example: `ru`

Responses

200 OK

List of vehicle applications

Body

application/json

{
  "items": [
    {
      "lead_id": "550e8400-e29b-41d4-a716-446655440000",
      "driver_id": "33de650c6a1a40bfa78dd981817da866",
      "driver_link": "https://fleet.yandex.ru/contractors?park_id=ee6f33c4562b4e1f8646d157bd70b2c4&contractor_id=33de650c6a1a40bfa78dd981817da866",
      "driver_name": {
        "first_name": "Ivan",
        "middle_name": "Ivanovich",
        "last_name": "Ivanov"
      },
      "driver_license": "7700123456",
      "phone": "+79999999999",
      "vehicle_id": "5011ade6ba054dfdb7143c8cc9460dbc",
      "vehicle_brand": "Toyota",
      "vehicle_model": "Camry",
      "territory_id": "213",
      "territory_name": "Москва",
      "offer_link": "https://garage.yandex.ru/offer?posting_id=posting_id1&territory_id=213",
      "schema": {
        "price": "1500.0000",
        "working_days": 6,
        "non_working_days": 1
      },
      "request_type": "multiple",
      "created_at": "2023-12-15T09:00:00+03:00",
      "updated_at": "2023-12-15T14:30:00+03:00"
    }
  ],
  "cursor": "eyJsZWFkX2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAwIn0="
}

Name

Description

items

Type: ContractorApplicationItem[]

List of applications

Example

[
  {
    "lead_id": "550e8400-e29b-41d4-a716-446655440000",
    "driver_id": "33de650c6a1a40bfa78dd981817da866",
    "driver_link": "https://fleet.yandex.ru/contractors?park_id=ee6f33c4562b4e1f8646d157bd70b2c4&contractor_id=33de650c6a1a40bfa78dd981817da866",
    "driver_name": {
      "first_name": "Ivan",
      "middle_name": "Ivanovich",
      "last_name": "Ivanov"
    },
    "driver_license": "7700123456",
    "phone": "+79999999999",
    "vehicle_id": "5011ade6ba054dfdb7143c8cc9460dbc",
    "vehicle_brand": "Toyota",
    "vehicle_model": "Camry",
    "territory_id": "213",
    "territory_name": "Москва",
    "offer_link": "https://garage.yandex.ru/offer?posting_id=posting_id1&territory_id=213",
    "schema": {
      "price": "1500.0000",
      "working_days": 6,
      "non_working_days": 1
    },
    "request_type": "multiple",
    "created_at": "2023-12-15T09:00:00+03:00",
    "updated_at": "2023-12-15T14:30:00+03:00"
  }
]

cursor

Type: string

Cursor for next page

Example: eyJsZWFkX2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAwIn0=

FirstName

Name

Type: string

Example: Ivan

MiddleName

Middle name

Type: string

Example: Ivanovich

LastName

Last name

Type: string

Example: Ivanov

FullName

Driver's full name

Name	Description
first_name	Type: FirstName Name Example: `Ivan`
last_name	Type: LastName Last name Example: `Ivanov`
middle_name	Type: MiddleName Middle name Example: `Ivanovich`

Example

{
  "first_name": "Ivan",
  "middle_name": "Ivanovich",
  "last_name": "Ivanov"
}

ContractorApplicationItem

Name

Description

lead_id

Type: string<uuid>

Lead ID

Example: 550e8400-e29b-41d4-a716-446655440000

phone

Type: string

Phone number

Example: +79999999999

vehicle_id

Type: string

Vehicle ID

Example: 5011ade6ba054dfdb7143c8cc9460dbc

created_at

Type: string<date-time>

Application creation date and time

Example: 2023-12-15T09:00:00+03:00

driver_id

Type: string

Driver ID

Example: 33de650c6a1a40bfa78dd981817da866

driver_license

Type: string

Driver's license number

Example: 7700123456

driver_link

Type: string

Link to contractor or candidate profile in the Dispatcher

Example: https://fleet.yandex.ru/contractors?park_id=ee6f33c4562b4e1f8646d157bd70b2c4&contractor_id=33de650c6a1a40bfa78dd981817da866

driver_name

Type: FullName

Driver's full name

Example

{
  "first_name": "Ivan",
  "middle_name": "Ivanovich",
  "last_name": "Ivanov"
}

offer_link

Type: string

Link to garage posting

Example: https://garage.yandex.ru/offer?posting_id=posting_id1&territory_id=213

request_type

Type: string

Request type: phonecall - created by phone call, multiple - multibooking

Enum: phonecall, multiple

schema

Type: object

non_working_days

Type: integer

Number of days when the car is not rented

price

Type: string

Daily rental price

Pattern: ^[0-9]+(\.[0-9]{1,4})?$

Example: 1500.0000

working_days

Type: integer

Number of days when the car is rented

Rental scheme

Example

{
  "price": "1500.0000",
  "working_days": 6,
  "non_working_days": 1
}

territory_id

Type: string

Territory ID

Example: 213

territory_name

Type: string

Territory name

Example: Москва

updated_at

Type: string<date-time>

Application update date and time

Example: 2023-12-15T14:30:00+03:00

vehicle_brand

Type: string

Vehicle brand

Example: Toyota

vehicle_model

Type: string

Vehicle model

Example: Camry

Example

{
  "lead_id": "550e8400-e29b-41d4-a716-446655440000",
  "driver_id": "33de650c6a1a40bfa78dd981817da866",
  "driver_link": "https://fleet.yandex.ru/contractors?park_id=ee6f33c4562b4e1f8646d157bd70b2c4&contractor_id=33de650c6a1a40bfa78dd981817da866",
  "driver_name": {
    "first_name": "Ivan",
    "middle_name": "Ivanovich",
    "last_name": "Ivanov"
  },
  "driver_license": "7700123456",
  "phone": "+79999999999",
  "vehicle_id": "5011ade6ba054dfdb7143c8cc9460dbc",
  "vehicle_brand": "Toyota",
  "vehicle_model": "Camry",
  "territory_id": "213",
  "territory_name": "Москва",
  "offer_link": "https://garage.yandex.ru/offer?posting_id=posting_id1&territory_id=213",
  "schema": {
    "price": "1500.0000",
    "working_days": 6,
    "non_working_days": 1
  },
  "request_type": "multiple",
  "created_at": "2023-12-15T09:00:00+03:00",
  "updated_at": "2023-12-15T14:30:00+03:00"
}

400 Bad Request

Invalid request parameters

Body

application/json

{
  "code": "example",
  "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

Example: example

401 Unauthorized

Request authorization parameters are missing

Body

application/json

{
  "code": "example",
  "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

Example: example

403 Forbidden

Insufficient rights to execute the request

Body

application/json

{
  "code": "example",
  "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

Example: example

429 Too Many Requests

Limit of requests was exceeded

Body

application/json

{
  "code": "example",
  "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

Example: example

500 Internal Server Error

Internal server error

Body

application/json

{
  "code": "example",
  "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

Example: example

Was the article helpful?

Getting driver's balance and blocked balance

Getting list of work rules