External Integration API
Drivers — External Integration API
This API provides real-time driver data access, allowing partners to retrieve active or inactive drivers and paginate through large lists.
Platform
| Base Read API URL |
|---|
|
Authentication
Two headers are required for every request:
| Header | Required | Purpose |
|---|---|---|
x-api-key | Yes | API key |
provider-token | Yes | Provider authentication token |
Endpoint
GET/api/externalservice/drivers-list/:usdot?page={page}&perPage={perPage}&is_active={boolean}
Query Parameters
| Parameter | Required | Description |
|---|---|---|
usdot | Yes | Company USDOT number (path parameter) |
page | No | Pagination page number |
perPage | No | Number of results per page |
is_active | Yes | true for active drivers, false for inactive |
Response Structure
Returns driver records plus pagination metadata. The data array contains driver objects, and meta provides pagination info.
json
{
"data": [
{
"id": "string(uuid)",
"first_name": "string",
"second_name": "string"
}
],
"meta": {
"page": 1,
"perPage": 10,
"total": 100,
"totalPages": 10
}
}Example Request
bash
Contact the support team for access credentials or integration assistance.