---
metadata:
  - name: generator
    content: Diplodoc Platform v5.47.1
alternate:
  - https://fleet.yandex.ru/docs/api/en/openapi/ContractorProfiles/v1parksdriver-profileslist-post.md
  - https://fleet.yandex.ru/docs/api/ru/openapi/ContractorProfiles/v1parksdriver-profileslist-post.md
---
> **Documentation Index:** Fetch the complete configuration index at https://fleet.yandex.ru/docs/api/en/llms.txt

<div class="openapi">

#  Getting list of driver profiles (couriers) 

<!-- markdownlint-disable-file -->

 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

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-post);margin-bottom: 12px">

<div class="openapi__request">

POST {.openapi__method}
```text translate=no
https://fleet-api.taxi.yandex.net/v1/parks/driver-profiles/list
```

</div>

</div>

</div>

### Headers

#|
|| **Name** | **Description** ||
||

_Accept-Language_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Preferred language of the response 

_Min length:_{.json-schema-reset .json-schema-assertion} `2`

_Example:_{.json-schema-reset .json-schema-example} `ru`
{.table-cell}
||
||

_X-API-Key_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 API-key 

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Example:_{.json-schema-reset .json-schema-example} `<API key>`
{.table-cell}
||
||

_X-Client-ID_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Client ID 

_Min length:_{.json-schema-reset .json-schema-assertion} `1`

_Example:_{.json-schema-reset .json-schema-example} `<Client ID>`
{.table-cell}
||
|#{.json-schema-properties}

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "query": {
    "park": {
      "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
      "driver_profile": {
        "id": [
          "2111ade6gk054dfdb9iu8c8cc9460mks"
        ],
        "work_rule_id": [
          "bc43tre6ba054dfdb7143ckfgvcby63e"
        ],
        "work_status": [
          "working"
        ]
      },
      "current_status": {
        "status": [
          "free"
        ]
      },
      "account": {
        "last_transaction_date": {
          "from": "2025-01-01T00:00:00Z",
          "to": "2025-01-01T00:00:00Z"
        }
      },
      "updated_at": {
        "from": "2025-01-01T00:00:00Z",
        "to": "2025-01-01T00:00:00Z"
      }
    },
    "text": "example"
  },
  "fields": {
    "account": [
      "balance"
    ],
    "car": [
      "color"
    ],
    "current_status": [
      "status"
    ],
    "driver_profile": [
      "last_name"
    ],
    "park": [
      "name"
    ],
    "updated_at": true
  },
  "sort_order": [
    {
      "direction": "asc",
      "field": "driver_profile.created_date"
    }
  ],
  "limit": 200,
  "offset": 0
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_query_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [DriverProfilesListRequestQuery](#entity-DriverProfilesListRequestQuery)

 Filters can be merged using logical "AND" 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "park": {
    "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
    "driver_profile": {
      "id": [
        "2111ade6gk054dfdb9iu8c8cc9460mks"
      ],
      "work_rule_id": [
        "bc43tre6ba054dfdb7143ckfgvcby63e"
      ],
      "work_status": [
        "working"
      ]
    },
    "current_status": {
      "status": [
        "free"
      ]
    },
    "account": {
      "last_transaction_date": {
        "from": "2025-01-01T00:00:00Z",
        "to": "2025-01-01T00:00:00Z"
      }
    },
    "updated_at": {
      "from": "2025-01-01T00:00:00Z",
      "to": "2025-01-01T00:00:00Z"
    }
  },
  "text": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_fields_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DriverProfileListRequestFields](#entity-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"
    ]
}
``` 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "account": [
    "balance"
  ],
  "car": [
    "color"
  ],
  "current_status": [
    "status"
  ],
  "driver_profile": [
    "last_name"
  ],
  "park": [
    "name"
  ],
  "updated_at": true
}
```

{% endcut %}
{.table-cell}
||
||

_limit_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

 Number of list items being requested 

_Default:_{.json-schema-reset .json-schema-value} `1000`

_Min value:_{.json-schema-reset .json-schema-assertion} `1`

_Max value:_{.json-schema-reset .json-schema-assertion} `1000`
{.table-cell}
||
||

_offset_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

 Offset from the beginning of the list 

_Default:_{.json-schema-reset .json-schema-value} `0`

_Min value:_{.json-schema-reset .json-schema-assertion} `0`
{.table-cell}
||
||

_sort_order_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DriverProfileRequestSortOrder](#entity-DriverProfileRequestSortOrder)

 An array of fields to define profiles order in the response 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "direction": "asc",
    "field": "driver_profile.created_date"
  }
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### ParkId {#entity-ParkId}

 Partner ID 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `ee6f33c4562b4e1f8646d157bd70b2c4`

</div>

<div class="openapi-entity">

### ContractorProfileId {#entity-ContractorProfileId}

 Driver's profile ID 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `2111ade6gk054dfdb9iu8c8cc9460mks`

</div>

<div class="openapi-entity">

### WorkRuleId {#entity-WorkRuleId}

 Work rule ID 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `bc43tre6ba054dfdb7143ckfgvcby63e`

</div>

<div class="openapi-entity">

### WorkStatus {#entity-WorkStatus}

 Driver's working status. Possible values:
* `working` — "Is working" status.
* `not_working` — "Not working" status;
* `fired` — status for dismissed drivers; 

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `working`, `not_working`, `fired`

</div>

<div class="openapi-entity">

### DriverProfilesListRequestQueryParkDriverProfile {#entity-DriverProfilesListRequestQueryParkDriverProfile}

 Filters by driver profile data 

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [ContractorProfileId](#entity-ContractorProfileId)[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "2111ade6gk054dfdb9iu8c8cc9460mks"
]
```

{% endcut %}
{.table-cell}
||
||

_work_rule_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [WorkRuleId](#entity-WorkRuleId)[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "bc43tre6ba054dfdb7143ckfgvcby63e"
]
```

{% endcut %}
{.table-cell}
||
||

_work_status_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [WorkStatus](#entity-WorkStatus)[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "working"
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": [
    "2111ade6gk054dfdb9iu8c8cc9460mks"
  ],
  "work_rule_id": [
    "bc43tre6ba054dfdb7143ckfgvcby63e"
  ],
  "work_status": [
    "working"
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DriverStatus {#entity-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**: string

_Enum:_{.json-schema-reset .json-schema-value} `offline`, `busy`, `free`, `in_order_free`, `in_order_busy`

</div>

<div class="openapi-entity">

### DriverProfilesListRequestQueryParkCurrentStatus {#entity-DriverProfilesListRequestQueryParkCurrentStatus}

 Filter by driver's current state 

#|
|| **Name** | **Description** ||
||

_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [DriverStatus](#entity-DriverStatus)[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "free"
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "status": [
    "free"
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DriverProfilesListRequestQueryParkAccountLastTransactionDate {#entity-DriverProfilesListRequestQueryParkAccountLastTransactionDate}

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

#|
|| **Name** | **Description** ||
||

_from_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

 Start time as per [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) 

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_to_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

 End time as per [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) 

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "from": "2025-01-01T00:00:00Z",
  "to": "2025-01-01T00:00:00Z"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DriverProfilesListRequestQueryParkAccount {#entity-DriverProfilesListRequestQueryParkAccount}

 Filters by account data 

#|
|| **Name** | **Description** ||
||

_last_transaction_date_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DriverProfilesListRequestQueryParkAccountLastTransactionDate](#entity-DriverProfilesListRequestQueryParkAccountLastTransactionDate)

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "from": "2025-01-01T00:00:00Z",
  "to": "2025-01-01T00:00:00Z"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "last_transaction_date": {
    "from": "2025-01-01T00:00:00Z",
    "to": "2025-01-01T00:00:00Z"
  }
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DriverProfilesListRequestQueryParkUpdatedAt {#entity-DriverProfilesListRequestQueryParkUpdatedAt}

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

#|
|| **Name** | **Description** ||
||

_from_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

 Start time as per [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) 

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_to_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

 End time as per [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) 

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "from": "2025-01-01T00:00:00Z",
  "to": "2025-01-01T00:00:00Z"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DriverProfilesListRequestQueryPark {#entity-DriverProfilesListRequestQueryPark}

 Partner parameters 

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [ParkId](#entity-ParkId)

 Partner ID 

_Example:_{.json-schema-reset .json-schema-example} `ee6f33c4562b4e1f8646d157bd70b2c4`
{.table-cell}
||
||

_account_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DriverProfilesListRequestQueryParkAccount](#entity-DriverProfilesListRequestQueryParkAccount)

 Filters by account data 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "last_transaction_date": {
    "from": "2025-01-01T00:00:00Z",
    "to": "2025-01-01T00:00:00Z"
  }
}
```

{% endcut %}
{.table-cell}
||
||

_current_status_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DriverProfilesListRequestQueryParkCurrentStatus](#entity-DriverProfilesListRequestQueryParkCurrentStatus)

 Filter by driver's current state 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "status": [
    "free"
  ]
}
```

{% endcut %}
{.table-cell}
||
||

_driver_profile_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DriverProfilesListRequestQueryParkDriverProfile](#entity-DriverProfilesListRequestQueryParkDriverProfile)

 Filters by driver profile data 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": [
    "2111ade6gk054dfdb9iu8c8cc9460mks"
  ],
  "work_rule_id": [
    "bc43tre6ba054dfdb7143ckfgvcby63e"
  ],
  "work_status": [
    "working"
  ]
}
```

{% endcut %}
{.table-cell}
||
||

_updated_at_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DriverProfilesListRequestQueryParkUpdatedAt](#entity-DriverProfilesListRequestQueryParkUpdatedAt)

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "from": "2025-01-01T00:00:00Z",
  "to": "2025-01-01T00:00:00Z"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
  "driver_profile": {
    "id": [
      "2111ade6gk054dfdb9iu8c8cc9460mks"
    ],
    "work_rule_id": [
      "bc43tre6ba054dfdb7143ckfgvcby63e"
    ],
    "work_status": [
      "working"
    ]
  },
  "current_status": {
    "status": [
      "free"
    ]
  },
  "account": {
    "last_transaction_date": {
      "from": "2025-01-01T00:00:00Z",
      "to": "2025-01-01T00:00:00Z"
    }
  },
  "updated_at": {
    "from": "2025-01-01T00:00:00Z",
    "to": "2025-01-01T00:00:00Z"
  }
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DriverProfilesListRequestQuery {#entity-DriverProfilesListRequestQuery}

 Filters can be merged using logical "AND" 

#|
|| **Name** | **Description** ||
||

_park_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DriverProfilesListRequestQueryPark](#entity-DriverProfilesListRequestQueryPark)

 Partner parameters 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
  "driver_profile": {
    "id": [
      "2111ade6gk054dfdb9iu8c8cc9460mks"
    ],
    "work_rule_id": [
      "bc43tre6ba054dfdb7143ckfgvcby63e"
    ],
    "work_status": [
      "working"
    ]
  },
  "current_status": {
    "status": [
      "free"
    ]
  },
  "account": {
    "last_transaction_date": {
      "from": "2025-01-01T00:00:00Z",
      "to": "2025-01-01T00:00:00Z"
    }
  },
  "updated_at": {
    "from": "2025-01-01T00:00:00Z",
    "to": "2025-01-01T00:00:00Z"
  }
}
```

{% endcut %}
{.table-cell}
||
||

_text_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Arbitrary full-text search request 

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "park": {
    "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
    "driver_profile": {
      "id": [
        "2111ade6gk054dfdb9iu8c8cc9460mks"
      ],
      "work_rule_id": [
        "bc43tre6ba054dfdb7143ckfgvcby63e"
      ],
      "work_status": [
        "working"
      ]
    },
    "current_status": {
      "status": [
        "free"
      ]
    },
    "account": {
      "last_transaction_date": {
        "from": "2025-01-01T00:00:00Z",
        "to": "2025-01-01T00:00:00Z"
      }
    },
    "updated_at": {
      "from": "2025-01-01T00:00:00Z",
      "to": "2025-01-01T00:00:00Z"
    }
  },
  "text": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### VehicleField {#entity-VehicleField}

 Vehicle field 

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `id`, `status`, `amenities`, `category`, `callsign`, `brand`, `model`, `year`, `color`, `number`, `registration_cert`, `vin`

</div>

<div class="openapi-entity">

### VehicleFields {#entity-VehicleFields}

 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). 

**Type**: [VehicleField](#entity-VehicleField)[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "color"
]
```

{% endcut %}

</div>

<div class="openapi-entity">

### DriverProfileListRequestFields {#entity-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_{.json-schema-reset .json-schema-property}
{.table-cell}|
**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](https://en.wikipedia.org/wiki/ISO_4217).
* `last_transaction_date` — date of the last transaction 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "balance"
]
```

{% endcut %}
{.table-cell}
||
||

_car_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [VehicleFields](#entity-VehicleFields)

 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). 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "color"
]
```

{% endcut %}
{.table-cell}
||
||

_current_status_{.json-schema-reset .json-schema-property}
{.table-cell}|
**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. 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "status"
]
```

{% endcut %}
{.table-cell}
||
||

_driver_profile_{.json-schema-reset .json-schema-property}
{.table-cell}|
**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](https://en.wikipedia.org/wiki/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. 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "last_name"
]
```

{% endcut %}
{.table-cell}
||
||

_park_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[]

 Partner data to be retrieved. Possible values:
* `id` — partner ID;
* `city` — city where the partner is located;
* `name` — name of a partner. 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "name"
]
```

{% endcut %}
{.table-cell}
||
||

_updated_at_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

 Whether to return time of latest update 
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "account": [
    "balance"
  ],
  "car": [
    "color"
  ],
  "current_status": [
    "status"
  ],
  "driver_profile": [
    "last_name"
  ],
  "park": [
    "name"
  ],
  "updated_at": true
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DriverProfileRequestSortOrderField {#entity-DriverProfileRequestSortOrderField}

#|
|| **Name** | **Description** ||
||

_direction_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Sorting direction. Possible values:
* `asc` — ascending sorting;
* `desc` — descending sorting. 

_Enum:_{.json-schema-reset .json-schema-value} `asc`, `desc`
{.table-cell}
||
||

_field_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**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. 

_Enum:_{.json-schema-reset .json-schema-value} `account.current.balance`, `driver_profile.created_date`, `driver_profile.last_name`, `driver_profile.first_name`, `driver_profile.middle_name`, `updated_at`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "direction": "asc",
  "field": "driver_profile.created_date"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DriverProfileRequestSortOrder {#entity-DriverProfileRequestSortOrder}

 An array of fields to define profiles order in the response 

**Type**: [DriverProfileRequestSortOrderField](#entity-DriverProfileRequestSortOrderField)[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "direction": "asc",
    "field": "driver_profile.created_date"
  }
]
```

{% endcut %}

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

 List of driver profiles was received successfully 

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "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": true
      }
    }
  ],
  "parks": [
    {
      "id": null,
      "city": "Tel Aviv",
      "name": "Mickey Mouse Company"
    }
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_driver_profiles_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [DriverProfile](#entity-DriverProfile)[]

 List of profiles 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "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": true
    }
  }
]
```

{% endcut %}
{.table-cell}
||
||

_limit_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

 Requested number of list items 
{.table-cell}
||
||

_offset_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

 Requested offset from the beginning of the list 
{.table-cell}
||
||

_parks_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [DriverProfilePark](#entity-DriverProfilePark)[]

 List of partners 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
    "city": "Tel Aviv",
    "name": "Mickey Mouse Company"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_total_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

 Total number of list items 
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### AccountId {#entity-AccountId}

 Account ID 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `33de650c6a1a40bfa78dd981817da866`

</div>

<div class="openapi-entity">

### AccountType {#entity-AccountType}

 Account type. Possible values:
* `current` — current account. 

**Type**: string

_Const:_{.json-schema-reset .json-schema-value} `current`

_Example:_{.json-schema-reset .json-schema-example} `current`

</div>

<div class="openapi-entity">

### AccountBalance {#entity-AccountBalance}

 Current account balance (fixed-point sum) 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `700.0000`

</div>

<div class="openapi-entity">

### BalanceLimit {#entity-BalanceLimit}

 Balance limit 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `50`

</div>

<div class="openapi-entity">

### Currency {#entity-Currency}

 Currency as per [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `RUB`

</div>

<div class="openapi-entity">

### DriverProfileAccount {#entity-DriverProfileAccount}

 Account information 

#|
|| **Name** | **Description** ||
||

_balance_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [AccountBalance](#entity-AccountBalance)

 Current account balance (fixed-point sum) 

_Example:_{.json-schema-reset .json-schema-example} `700.0000`
{.table-cell}
||
||

_balance_limit_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [BalanceLimit](#entity-BalanceLimit)

 Balance limit 

_Example:_{.json-schema-reset .json-schema-example} `50`
{.table-cell}
||
||

_currency_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Currency](#entity-Currency)

 Currency as per [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 

_Example:_{.json-schema-reset .json-schema-example} `RUB`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [AccountId](#entity-AccountId)

 Account ID 

_Example:_{.json-schema-reset .json-schema-example} `33de650c6a1a40bfa78dd981817da866`
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [AccountType](#entity-AccountType)

 Account type. Possible values:
* `current` — current account. 

_Enum:_{.json-schema-reset .json-schema-value} `current`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "33de650c6a1a40bfa78dd981817da866",
  "type": "current",
  "balance": "700.0000",
  "balance_limit": "50",
  "currency": "RUB"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### VehicleId {#entity-VehicleId}

 Vehicle ID 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `2111ade6gk054dfdb9iu8c8cc9460mks`

</div>

<div class="openapi-entity">

### Status {#entity-Status}

 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. 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `working`

</div>

<div class="openapi-entity">

### Amenities {#entity-Amenities}

 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` 

**Type**: string[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "wifi"
]
```

{% endcut %}

</div>

<div class="openapi-entity">

### Categories {#entity-Categories}

 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. 

**Type**: string[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "econom"
]
```

{% endcut %}

</div>

<div class="openapi-entity">

### Callsign {#entity-Callsign}

 Vehicle code name (short name) 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `123456789`

</div>

<div class="openapi-entity">

### Brand {#entity-Brand}

 Vehicle make 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `Mercedes-Benz`

</div>

<div class="openapi-entity">

### Model {#entity-Model}

 Vehicle model 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `E-klasse`

</div>

<div class="openapi-entity">

### Year {#entity-Year}

 Year of vehicle manufacture 

**Type**: integer

</div>

<div class="openapi-entity">

### ColorEnum {#entity-ColorEnum}

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

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `Белый`, `Желтый`, `Бежевый`, `Черный`, `Голубой`, `Серый`, `Красный`, `Оранжевый`, `Синий`, `Зеленый`, `Коричневый`, `Фиолетовый`, `Розовый`

</div>

<div class="openapi-entity">

### LicencePlateNumber {#entity-LicencePlateNumber}

 License plate number 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `Т8654Т99`

</div>

<div class="openapi-entity">

### RegistrationCertificate {#entity-RegistrationCertificate}

 Vehicle registration certificate (Required field for Russia) 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `123456789`

</div>

<div class="openapi-entity">

### VIN {#entity-VIN}

 VIN (Required field for Russia) 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `12345678909876543`

</div>

<div class="openapi-entity">

### Vehicle {#entity-Vehicle}

 Vehicle data 

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [VehicleId](#entity-VehicleId)

 Vehicle ID 

_Example:_{.json-schema-reset .json-schema-example} `2111ade6gk054dfdb9iu8c8cc9460mks`
{.table-cell}
||
||

_amenities_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Amenities](#entity-Amenities)

 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` 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "wifi"
]
```

{% endcut %}
{.table-cell}
||
||

_brand_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Brand](#entity-Brand)

 Vehicle make 

_Example:_{.json-schema-reset .json-schema-example} `Mercedes-Benz`
{.table-cell}
||
||

_callsign_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Callsign](#entity-Callsign)

 Vehicle code name (short name) 

_Example:_{.json-schema-reset .json-schema-example} `123456789`
{.table-cell}
||
||

_category_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Categories](#entity-Categories)

 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. 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "econom"
]
```

{% endcut %}
{.table-cell}
||
||

_color_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [ColorEnum](#entity-ColorEnum)

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

_Enum:_{.json-schema-reset .json-schema-value} `Белый`, `Желтый`, `Бежевый`, `Черный`, `Голубой`, `Серый`, `Красный`, `Оранжевый`, `Синий`, `Зеленый`, `Коричневый`, `Фиолетовый`, `Розовый`
{.table-cell}
||
||

_model_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Model](#entity-Model)

 Vehicle model 

_Example:_{.json-schema-reset .json-schema-example} `E-klasse`
{.table-cell}
||
||

_number_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [LicencePlateNumber](#entity-LicencePlateNumber)

 License plate number 

_Example:_{.json-schema-reset .json-schema-example} `Т8654Т99`
{.table-cell}
||
||

_registration_cert_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [RegistrationCertificate](#entity-RegistrationCertificate)

 Vehicle registration certificate (Required field for Russia) 

_Example:_{.json-schema-reset .json-schema-example} `123456789`
{.table-cell}
||
||

_status_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Status](#entity-Status)

 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:_{.json-schema-reset .json-schema-example} `working`
{.table-cell}
||
||

_vin_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [VIN](#entity-VIN)

 VIN (Required field for Russia) 

_Example:_{.json-schema-reset .json-schema-example} `12345678909876543`
{.table-cell}
||
||

_year_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Year](#entity-Year)

 Year of vehicle manufacture 

_Example:_{.json-schema-reset .json-schema-example} `2019`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DriverProfileCurrentStatus {#entity-DriverProfileCurrentStatus}

#|
|| **Name** | **Description** ||
||

_status_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DriverStatus](#entity-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). 

_Enum:_{.json-schema-reset .json-schema-value} `offline`, `busy`, `free`, `in_order_free`, `in_order_busy`
{.table-cell}
||
||

_status_updated_at_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Time of the last update of the current driver status in the [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601) format. 

_Example:_{.json-schema-reset .json-schema-example} `2020-04-27T08:44:05.871+0000`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "status": "free",
  "status_updated_at": "2020-04-27T08:44:05.871+0000"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### LastName {#entity-LastName}

 Last name 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `Ivanov`

</div>

<div class="openapi-entity">

### FirstName {#entity-FirstName}

 Name 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `Ivan`

</div>

<div class="openapi-entity">

### MiddleName {#entity-MiddleName}

 Middle name 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `Ivanovich`

</div>

<div class="openapi-entity">

### IssueDate {#entity-IssueDate}

 Date of issue of the driver's license in ISO 8601 format without time zone 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `2020-10-28`

</div>

<div class="openapi-entity">

### ExpiryDate {#entity-ExpiryDate}

 Driver's license expiry date in ISO 8601 format without time zone 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `2050-10-28`

</div>

<div class="openapi-entity">

### Number {#entity-Number}

 Driver's license series and number 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `070236`

</div>

<div class="openapi-entity">

### NormalizedNumber {#entity-NormalizedNumber}

 Normalized series and number (Cyrillic letters have been replaced by Latin letters) 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `AA00123456`

</div>

<div class="openapi-entity">

### CountryCode {#entity-CountryCode}

 Country of issue (Three-letter code) 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `rus`

</div>

<div class="openapi-entity">

### BirthDate {#entity-BirthDate}

 Birth date in ISO 8601 format without time zone 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `1975-10-28`

</div>

<div class="openapi-entity">

### DriverLicense {#entity-DriverLicense}

 Driver's license 

#|
|| **Name** | **Description** ||
||

_country_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [CountryCode](#entity-CountryCode)

 Country of issue (Three-letter code) 

_Example:_{.json-schema-reset .json-schema-example} `rus`
{.table-cell}
||
||

_normalized_number_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [NormalizedNumber](#entity-NormalizedNumber)

 Normalized series and number (Cyrillic letters have been replaced by Latin letters) 

_Example:_{.json-schema-reset .json-schema-example} `AA00123456`
{.table-cell}
||
||

_number_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [Number](#entity-Number)

 Driver's license series and number 

_Example:_{.json-schema-reset .json-schema-example} `070236`
{.table-cell}
||
||

_birth_date_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [BirthDate](#entity-BirthDate)

 Birth date in ISO 8601 format without time zone 

_Example:_{.json-schema-reset .json-schema-example} `1975-10-28`
{.table-cell}
||
||

_expiration_date_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [ExpiryDate](#entity-ExpiryDate)

 Driver's license expiry date in ISO 8601 format without time zone 

_Example:_{.json-schema-reset .json-schema-example} `2050-10-28`
{.table-cell}
||
||

_issue_date_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [IssueDate](#entity-IssueDate)

 Date of issue of the driver's license in ISO 8601 format without time zone 

_Example:_{.json-schema-reset .json-schema-example} `2020-10-28`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "issue_date": "2020-10-28",
  "expiration_date": "2050-10-28",
  "number": "070236",
  "normalized_number": "AA00123456",
  "country": "rus",
  "birth_date": "1975-10-28"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### Phone {#entity-Phone}

 Phone number 

**Type**: string

_Pattern:_{.json-schema-reset .json-schema-assertion} `^\+\d{1,15}$`

_Example:_{.json-schema-reset .json-schema-example} `+79999999999`

</div>

<div class="openapi-entity">

### FeedBack {#entity-FeedBack}

 Notes (available to park employees) 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `great driver`

</div>

<div class="openapi-entity">

### Comment {#entity-Comment}

 Notes 

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `great driver`

</div>

<div class="openapi-entity">

### EmploymentType {#entity-EmploymentType}

 Driver's employment type. Possible values:
* `selfemployed` — Self-employed;
* `park_employee` — Park employee;
* `individual_entrepreneur` — Individual entrepreneur; 

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `selfemployed`, `park_employee`, `individual_entrepreneur`

</div>

<div class="openapi-entity">

### HasContractIssue {#entity-HasContractIssue}

 There are problems with confirming employment 

**Type**: boolean

</div>

<div class="openapi-entity">

### DriverProfileModel {#entity-DriverProfileModel}

 Driver profile 

#|
|| **Name** | **Description** ||
||

_check_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [FeedBack](#entity-FeedBack)

 Notes (available to park employees) 

_Example:_{.json-schema-reset .json-schema-example} `great driver`
{.table-cell}
||
||

_comment_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Comment](#entity-Comment)

 Notes 

_Example:_{.json-schema-reset .json-schema-example} `great driver`
{.table-cell}
||
||

_created_date_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Date of profile creation as per [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) 

_Example:_{.json-schema-reset .json-schema-example} `2020-04-23T13:08:05.552+0000`
{.table-cell}
||
||

_driver_license_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DriverLicense](#entity-DriverLicense)

 Driver's license 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "issue_date": "2020-10-28",
  "expiration_date": "2050-10-28",
  "number": "070236",
  "normalized_number": "AA00123456",
  "country": "rus",
  "birth_date": "1975-10-28"
}
```

{% endcut %}
{.table-cell}
||
||

_employment_type_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [EmploymentType](#entity-EmploymentType)

 Driver's employment type. Possible values:
* `selfemployed` — Self-employed;
* `park_employee` — Park employee;
* `individual_entrepreneur` — Individual entrepreneur; 

_Enum:_{.json-schema-reset .json-schema-value} `selfemployed`, `park_employee`, `individual_entrepreneur`
{.table-cell}
||
||

_first_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [FirstName](#entity-FirstName)

 Name 

_Example:_{.json-schema-reset .json-schema-example} `Ivan`
{.table-cell}
||
||

_has_contract_issue_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [HasContractIssue](#entity-HasContractIssue)

 There are problems with confirming employment 

_Example:_{.json-schema-reset .json-schema-example} `true`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [ContractorProfileId](#entity-ContractorProfileId)

 Driver's profile ID 

_Example:_{.json-schema-reset .json-schema-example} `2111ade6gk054dfdb9iu8c8cc9460mks`
{.table-cell}
||
||

_last_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [LastName](#entity-LastName)

 Last name 

_Example:_{.json-schema-reset .json-schema-example} `Ivanov`
{.table-cell}
||
||

_middle_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [MiddleName](#entity-MiddleName)

 Middle name 

_Example:_{.json-schema-reset .json-schema-example} `Ivanovich`
{.table-cell}
||
||

_park_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [ParkId](#entity-ParkId)

 Partner ID 

_Example:_{.json-schema-reset .json-schema-example} `ee6f33c4562b4e1f8646d157bd70b2c4`
{.table-cell}
||
||

_phones_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Phone](#entity-Phone)[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "+79999999999"
]
```

{% endcut %}
{.table-cell}
||
||

_work_rule_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [WorkRuleId](#entity-WorkRuleId)

 Work rule ID 

_Example:_{.json-schema-reset .json-schema-example} `bc43tre6ba054dfdb7143ckfgvcby63e`
{.table-cell}
||
||

_work_status_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [WorkStatus](#entity-WorkStatus)

 Driver's working status. Possible values:
* `working` — "Is working" status.
* `not_working` — "Not working" status;
* `fired` — status for dismissed drivers; 

_Enum:_{.json-schema-reset .json-schema-value} `working`, `not_working`, `fired`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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": true
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DriverProfile {#entity-DriverProfile}

#|
|| **Name** | **Description** ||
||

_accounts_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DriverProfileAccount](#entity-DriverProfileAccount)[]

 List of accounts associated with the driver 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "33de650c6a1a40bfa78dd981817da866",
    "type": "current",
    "balance": "700.0000",
    "balance_limit": "50",
    "currency": "RUB"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_car_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Vehicle](#entity-Vehicle)

 Vehicle data 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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"
}
```

{% endcut %}
{.table-cell}
||
||

_current_status_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DriverProfileCurrentStatus](#entity-DriverProfileCurrentStatus)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "status": "free",
  "status_updated_at": "2020-04-27T08:44:05.871+0000"
}
```

{% endcut %}
{.table-cell}
||
||

_driver_profile_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DriverProfileModel](#entity-DriverProfileModel)

 Driver profile 

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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": true
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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": true
  }
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DriverProfilePark {#entity-DriverProfilePark}

#|
|| **Name** | **Description** ||
||

_city_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 City where the partner operates 

_Example:_{.json-schema-reset .json-schema-example} `Tel Aviv`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [ParkId](#entity-ParkId)

 Partner ID 

_Example:_{.json-schema-reset .json-schema-example} `ee6f33c4562b4e1f8646d157bd70b2c4`
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Partner name 

_Example:_{.json-schema-reset .json-schema-example} `Mickey Mouse Company`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
  "city": "Tel Aviv",
  "name": "Mickey Mouse Company"
}
```

{% endcut %}

</div>

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

 Invalid request parameters 

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "example",
  "message": "Textual description of the error"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Human-readable error message 

_Example:_{.json-schema-reset .json-schema-example} `Textual description of the error`
{.table-cell}
||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Machine-readable error code 

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__401">

## 401 Unauthorized

 Request authorization parameters are missing 

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "example",
  "message": "Textual description of the error"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Human-readable error message 

_Example:_{.json-schema-reset .json-schema-example} `Textual description of the error`
{.table-cell}
||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Machine-readable error code 

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__403">

## 403 Forbidden

 Insufficient rights to execute the request 

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "example",
  "message": "Textual description of the error"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Human-readable error message 

_Example:_{.json-schema-reset .json-schema-example} `Textual description of the error`
{.table-cell}
||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Machine-readable error code 

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__429">

## 429 Too Many Requests

 Limit of requests was exceeded 

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "example",
  "message": "Textual description of the error"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Human-readable error message 

_Example:_{.json-schema-reset .json-schema-example} `Textual description of the error`
{.table-cell}
||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Machine-readable error code 

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__500">

## 500 Internal Server Error

 Internal server error 

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "example",
  "message": "Textual description of the error"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

 Human-readable error message 

_Example:_{.json-schema-reset .json-schema-example} `Textual description of the error`
{.table-cell}
||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

 Machine-readable error code 

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.