List Trailers

GET

trailers

curl --request GET \
  --url https://api.withterminal.com/tsp/v1/trailers \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'

{
  "results": [
    {
      "id": "trl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "sourceId": "123456789",
      "provider": "geotab",
      "status": "active",
      "name": "Trailer #02323",
      "vin": "1HGCM82633A004352",
      "serialNumber": "004352",
      "make": "Great Dane Trailers",
      "model": "Champion CP Plate Van with 24 Posts",
      "year": 2013,
      "groups": [
        "group_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ],
      "licensePlate": {
        "state": "TN",
        "number": "ABC-1234"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "metadata": {
        "addedAt": "2023-11-07T05:31:56Z",
        "modifiedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "visibility": "visible"
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Connection-Token

string

required

The token returned when a user authenticated their account. This authorizes access to a specific account.

Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Query Parameters

limit

integer

The maximum number of results to return in a page.

cursor

string

Pagination cursor to start requests from

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

expand

enum<string>

Expand resources in the returned response

Available options:

groups

raw

boolean

Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified.

modifiedAfter

string

Only include records that were last modified after a provided date.

Example:

"2021-01-06T03:24:53.000Z"

modifiedBefore

string

Only include records that were last modified before a provided date.

Example:

"2021-01-06T03:24:53.000Z"

deleted

boolean

Show "soft-deleted" records that have been deleted from the provider. Defaults to false.

Response

200

application/json

results

object[]

required

results.id

string

required

Example:

"trl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

results.sourceId

string

required

The ID used to represent the entity in the source system.

Example:

"123456789"

results.provider

string

required

Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under provider details.

Example:

"geotab"

results.status

enum<string>

required

The status in the providers system

Available options:

active,

inactive

results.metadata

object

required

Internal metadata about the record.

results.name

string

Example:

"Trailer #02323"

results.vin

string

Example:

"1HGCM82633A004352"

results.serialNumber

string

Example:

"004352"

results.make

string

Example:

"Great Dane Trailers"

results.model

string

Example:

"Champion CP Plate Van with 24 Posts"

results.year

integer

Example:

2013

results.groups

array

Entities in Terminal are expandable. Using the expand query parameter you can choose to ingest just an ID or the full entity details.

results.licensePlate

object

results.createdAt

string

The date and time the record was created in the provider's system. This timestamp comes directly from the source system and represents when the data was originally created there. Note: not all providers expose this.

results.updatedAt

string

The date and time the record was updated in the provider's system. This timestamp comes directly from the source system and represents when the data was last updated there. Note: not all providers expose this.

results.raw

object[]

Raw data fetched from the source provider. Most of our endpoints support a raw query parameter that will append a list of the raw requests used to form our common model. This can be helpful for leveraging unique fields that are not part of our unified model.

Example:

[]

string

Cursor used for pagination.

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

List Groups Latest Trailer Locations

curl --request GET \
  --url https://api.withterminal.com/tsp/v1/trailers \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'

{
  "results": [
    {
      "id": "trl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "sourceId": "123456789",
      "provider": "geotab",
      "status": "active",
      "name": "Trailer #02323",
      "vin": "1HGCM82633A004352",
      "serialNumber": "004352",
      "make": "Great Dane Trailers",
      "model": "Champion CP Plate Van with 24 Posts",
      "year": 2013,
      "groups": [
        "group_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ],
      "licensePlate": {
        "state": "TN",
        "number": "ABC-1234"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "metadata": {
        "addedAt": "2023-11-07T05:31:56Z",
        "modifiedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "visibility": "visible"
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

API Reference

Authentication

Vehicles

Drivers

Hours of Service

Trips

Devices

Safety

Groups

Trailers

IFTA

Connections

Data Management

Providers

Issues

Webhook Events

Authorizations

Headers

Query Parameters

Response