Sign in

v1

latestOpenAPI 3.1.02026-07-22370342.6 KB
Connections

Get Current Connection

Get the details of the current active connection. The current connection is derived from the provided connection token.

get/connections/current

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.

Connection-Tokenstring required
Example:con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4

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

Response

OK

OR

Example response

{
  "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}",
  "lastSync": {
    "id": "sync_01GV12VR4DJP70GD1ZBK0SDWFH",
    "status": "completed",
    "failureReason": "Reason for failure if sync status is 'failed'",
    "progress": 85,
    "issues": [
      "isu_01D8ZQFGHVJ858NBF2Q7DV9MNC"
    ],
    "startFrom": "2021-01-06T03:24:53.000Z",
    "requestedAt": "2021-01-06T03:24:53.000Z",
    "completedAt": "2021-01-06T03:24:53.000Z",
    "attempts": 1,
    "providerRequests": [
      "historical_files"
    ]
  },
  "agreements": [
    {
      "id": "agr_01D9ZQFGHVJ858NBF2Q7DV9MNH",
      "connectionId": "conn_01GV12VR4DJP70GD1ZBK0SDWFH",
      "acceptedAt": "2021-01-06T03:24:53.000Z",
      "location": "New York, NY"
    }
  ]
}