Trucks - External Integration API Documentation

Overview

This document describes the External Integration API that provide access to real-time unit assignments. Collectively, this endpoint enable partners to:

  • View current unit assignments along with driver and co-driver information

Platform


Authentication

API requests must include the following headers:

Header NameRequiredDescription
x-api-keyYesAPI key
provider-tokenYesProvider authentication token

Current Units

Returns a real-time view of all units, including assigned driver and co-driver information. Data

Endpoint

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

Query Parameters

  • usdot(required): Company USDOT
  • page(optional): Pagination page
  • perPage(optional): Pagination per page
  • is_active(required): True or false

Example Request

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

Response

{
  "data": [
    {
      "id": "string(uuid)",
      "vin": "string",
      "truck_number": "string",
      "driver": {
        "id": "string",
        "first_name": "string",
        "second_name": "string"
      },
      "codriver": {
        "id": "string",
        "first_name": "string",
        "second_name": "string"
      }
    }
  ],
  "meta": {
    "page": integer,
    "perPage": integer,
    "total": integer,
    "totalPages": integer
  }
}

Example cURL Request

Current Units

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

Summary

Using this endpoints together allows integrators to:

  • Access current unit assignments along with driver and co-driver information

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