v1

latestOpenAPI 3.1.02026-07-22370342.6 KB

Connections

List All Connections

List all of the connections you have for your application. Connections represent the authenticated access you have to your customer's TSP data.

get/connections

Query parameters

cursorstring cursor

Example:cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

Pagination cursor to start requests from

limitinteger

The maximum number of results to return in a page.

externalIdstring

dotNumberstring

tagstring

Filter connections by tag

updatedAfterstring date-time

ISO 8601 date

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

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

updatedBeforestring date-time

ISO 8601 date

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

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

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
pending_deletion: connection has been marked for deletion and is awaiting the grace period
deleting: connection data is actively being deleted - this process is irreversible
deleted: connection data has been deleted and the record is retained as a stub

Filter connections by status

providerstring

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

Filter connections by provider

order'asc' | 'desc'

Sort order by id (which is monotonically increasing by creation time). desc returns the most recently created connections first.

Headers

X-Application-Idstring

Scopes the request to a Terminal application in the caller's organization. Required for multi-application organizations when using a user session or OAuth access token. API keys are already bound to a single application.

Response

nextstring cursor

Cursor used for pagination.

Example response

{
  "results": [
    {
      "id": "conn_01GV12VR4DJP70GD1ZBK0SDWFH",
      "company": {
        "name": "Frank's Trucking",
        "dotNumbers": [
          "1234567"
        ]
      },
      "account": {
        "name": "Frank's Trucking",
        "dotNumbers": [
          "1234567"
        ],
        "user": {
          "sourceId": "1234567",
          "firstName": "John",
          "lastName": "Doe",
          "email": "john.doe@example.com"
        }
      },
      "provider": {
        "code": "geotab",
        "name": "Geotab"
      },
      "externalId": "1234",
      "sourceId": "123456789",
      "token": "con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4",
      "tags": [
        "Tag Name"
      ],
      "createdAt": "2021-01-06T03:24:53.000Z",
      "updatedAt": "2021-01-06T03:24:53.000Z",
      "filters": {
        "vehicles": {
          "excludeIds": [
            "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
          ],
          "includeIds": [
            "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
          ]
        },
        "drivers": {
          "excludeIds": [
            "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
          ],
          "includeIds": [
            "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
          ]
        }
      },
      "linkUrl": "https://link.withterminal.com/connection/{CONNECTION_ID}?key={PUBLISHABLE_KEY}"
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}