List All Connections

GET

connections

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

{
  "results": [
    {
      "id": "conn_01GV12VR4DJP70GD1ZBK0SDWFH",
      "company": {
        "name": "Frank's Trucking",
        "dotNumbers": [
          "1234567"
        ]
      },
      "status": "connected",
      "provider": {
        "code": "geotab",
        "name": "Geotab"
      },
      "externalId": "1234",
      "sourceId": "123456789",
      "syncMode": "automatic",
      "token": "con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4",
      "tags": [
        "Tag Name"
      ],
      "options": {
        "ingestHistoryFromSourceSystem": true
      },
      "filters": {
        "vehicles": {
          "status": "active",
          "excludeIds": [
            "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
          ]
        }
      },
      "linkUrl": "https://link.withterminal.com/connection/{CONNECTION_ID}?key={PUBLISHABLE_KEY}",
      "createdAt": "2021-01-06T03:24:53.000Z",
      "updatedAt": "2021-01-06T03:24:53.000Z"
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

cursor

string

Pagination cursor to start requests from

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

limit

integer

The maximum number of results to return in a page.

externalId

string

dotNumber

string

tag

string

Filter connections by tag

updatedAfter

string

Filter connections that were last updated on or after a given time.

Example:

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

updatedBefore

string

Filter connections that were last updated on or before a given time.

Example:

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

Response

200

application/json

results

object[]

required

The connection your application has with your customer's TSP.

results.id

string

required

Example:

"conn_01GV12VR4DJP70GD1ZBK0SDWFH"

results.company

object

required

results.status

enum<string>

required

Enum values:

connected: active and authenticated connection
disconnected: connection is no longer authenticated - please ask your user to link the account again
archived: connection has been archived from view - attempts to re-connect will cause us to check the connection status again

Available options:

connected,

disconnected,

archived,

pending_deletion

results.provider

object

required

results.syncMode

enum<string>

default:automatic

required

Enum values:

automatic: Terminal will keep this connections data up to date
manual: Terminal will only sync data upon request

Available options:

automatic,

manual

results.token

string

required

This token is used when interacting with a connections' data.

Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

results.options

object

required

results.createdAt

string

required

ISO 8601 date

Example:

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

results.updatedAt

string

required

ISO 8601 date

Example:

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

results.externalId

string

An optional ID from your system that can be used to reference connections.

Example:

"1234"

results.sourceId

string

The ID used in the source system to represent the account this connection has access to.

This may be an organizationId or accountId.

Note: not all systems expose this information, in which case it may be undefined.

Example:

"123456789"

results.tags

string[]

An optional list of tags from your system that can be used to reference connections.

results.filters

object

Filters applied to connection data

results.linkUrl

string

The URL to send your user to in order to have them re-authenticate the connection.

Example:

"https://link.withterminal.com/connection/{CONNECTION_ID}?key={PUBLISHABLE_KEY}"

string

Cursor used for pagination.

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

Get IFTA Summary Get Current Connection

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

{
  "results": [
    {
      "id": "conn_01GV12VR4DJP70GD1ZBK0SDWFH",
      "company": {
        "name": "Frank's Trucking",
        "dotNumbers": [
          "1234567"
        ]
      },
      "status": "connected",
      "provider": {
        "code": "geotab",
        "name": "Geotab"
      },
      "externalId": "1234",
      "sourceId": "123456789",
      "syncMode": "automatic",
      "token": "con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4",
      "tags": [
        "Tag Name"
      ],
      "options": {
        "ingestHistoryFromSourceSystem": true
      },
      "filters": {
        "vehicles": {
          "status": "active",
          "excludeIds": [
            "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
          ]
        }
      },
      "linkUrl": "https://link.withterminal.com/connection/{CONNECTION_ID}?key={PUBLISHABLE_KEY}",
      "createdAt": "2021-01-06T03:24:53.000Z",
      "updatedAt": "2021-01-06T03:24:53.000Z"
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

API Reference

Authentication

Vehicles

Drivers

Hours of Service

Trips

Devices

Safety

Groups

Trailers

IFTA

Connections

Data Management

Providers

Issues

Webhook Events

List All Connections

Authorizations

Query Parameters

Response