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"
      ],
      "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
headerrequired

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

Query Parameters

cursor
string

Pagination cursor to start requests from

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.

updatedBefore
string

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

Response

200 - application/json
results
object[]
required
next
string

Cursor used for pagination.