Drivers

Overview

This document describes the External Integration API that provides access to real-time driver data. This endpoint enables partners to:

Retrieve active and inactive drivers
Navigate large driver lists using pagination

Platform

Base Read API URL: https://read.tteld.com

Authentication

API requests must include the following headers:

Header Name	Required	Description
`x-api-key`	Yes	API key
`provider-token`	Yes	Provider authentication token

Drivers List

Returns a real-time list of drivers. The list can be filtered by driver status (active or inactive) and supports pagination.

Endpoint

GET /api/externalservice/drivers-list/:usdot?page={pagination_page}&perPage={pagination_perPage}&is_active={boolean}

Query Parameters

Parameter	Required	Description
`usdot`	Yes	Company USDOT number
`page`	No	Page number for pagination
`perPage`	No	Number of drivers per page
`is_active`	Yes	Filter drivers by status (`true` for active, `false` for inactive)

Example Request

Retrieve active drivers with pagination:

GET https://read.tteld.com/api/externalservice/drivers-list/123456?page=1&perPage=10&is_active=true

Response

The response returns a paginated list of drivers along with metadata describing pagination details such as total records and total pages.

{
  "data": [
    {
      "id": "string",
      "first_name": "string",
      "second_name": "string"
    }
  ],
  "meta": {
    "page": 1,
    "perPage": 10,
    "total": 100,
    "totalPages": 10
  }
}

Example cURL Request

curl --location 'https://read.tteld.com/api/externalservice/drivers-list/123456?page=1&perPage=10&is_active=true' \
--header 'x-api-key: <your-api-key>' \
--header 'provider-token: <your-provider-token>'

Summary

Using this endpoint allows integrators to:

Retrieve active and inactive driver lists
Handle large datasets through pagination

For access credentials or further integration support, please contact the support team.