Skip to main content
POST
/
connections
Create Connection
curl --request POST \
  --url https://api.withterminal.com/tsp/v1/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "geotab",
  "credentials": {},
  "company": {
    "name": "<string>",
    "dotNumbers": [
      "<string>"
    ]
  },
  "options": {},
  "externalId": "<string>",
  "syncMode": "automatic",
  "backfill": {
    "startFrom": "2021-01-06T03:24:53.000Z",
    "days": 123
  },
  "tags": [
    "Tag Name"
  ],
  "agreements": [
    {
      "agreementUrl": "<string>",
      "type": "end-user-agreement",
      "ipAddress": "127.0.0.1",
      "acceptedAt": "2021-01-06T03:24:53.000Z",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36"
    }
  ]
}
'
{
  "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"
    }
  },
  "status": "connected",
  "provider": {
    "code": "geotab",
    "name": "Geotab"
  },
  "syncMode": "automatic",
  "token": "con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4",
  "options": {},
  "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",
  "externalId": "1234",
  "sourceId": "123456789",
  "tags": [
    "Tag Name"
  ],
  "filters": {
    "vehicles": {
      "status": "active",
      "excludeIds": [
        "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ],
      "includeIds": [
        "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ]
    },
    "drivers": {
      "status": "active",
      "excludeIds": [
        "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ],
      "includeIds": [
        "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ]
    }
  }
}
For most use cases we recommend using the Link UI to create connections.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
provider
enum<string>
required
Available options:
azuga,
bigroad,
conti-go,
eld-mandate,
eld-mandate-plus,
eld-mandate-hos,
eld-rider,
eldone,
envue-telematics,
eroad,
eva-eld,
attrix,
advantage-one,
argos,
fleet-profit-center,
fleethunt,
gps-tracking-canada,
graybox-solutions,
gridline,
high-point-gps,
io-tab,
blue-arrow,
eagle-wireless,
fleet-complete-hub,
fleet-pulse,
fleetistics,
fort-knox,
fm-eld,
geotab,
gofleet,
gogps,
gps-insight,
gpstab,
isaac,
ksk,
switchboard,
linxup,
coretex-360,
apollo,
apollo-eld,
apollo-compass,
top-tracking-system,
eld-mandate-prime,
hos-reporter-plus,
hos247,
black-bear,
columbus-eld,
phoenix-eld,
route-eld,
reliable-eld,
trust-eld,
abc-eld,
tempus-eld,
vlog-eld,
just-eld,
factor-eld,
moonlight-eld,
daily-eld,
dfl-eld,
hero-eld,
infinity-eld,
ampm-eld,
forza-eld,
action-eld,
state-elog,
dy-eld,
cobra-eld,
flash-elogs,
renaissance-eld,
robinhood-eld,
sr-eld,
speedline-eld,
eld-2-go,
captain-eld,
ironman-eld,
powertrucks-eld,
paragon-eld,
youlog-eld,
legacy-eld,
master-eld,
eld4trucking,
true-road-eld,
advantage-knights-eld,
eld-for-you,
elog42,
egreen-eld,
eld-connection,
empire-logs,
myway-eld,
solution-eld,
log-plus-eld,
bison-elog,
run-eld,
digital-eld,
pioneer-eld-solution,
orient-star-eld,
gt-eld,
ilog-eld,
novio-eld,
globcom-eld,
smart-choice-logs,
sf-eld,
starway-eld,
project-eld,
track-truck-eld,
teddy-eld,
xpert-logs,
secure-eld,
zaphira-eld,
under-control-eld,
unity-eld,
support-eld,
monarch-tracking,
wex-telematics,
motive,
mountain-eld,
omnitracs-es,
omnitracs-xrs,
omnitracs,
one-step-gps,
optima-eld,
pro-ride-eld,
pti-eld,
real-eld,
right-trucking,
roadstar,
routemate,
samsara,
sandbox,
sparkle-eld,
tx-eld,
surfsight,
tfm-eld,
transflo,
trimble,
truckx,
tt-eld,
verizon-fleet,
verizon-reveal,
verizon,
webfleet,
xeld,
xplore-eld,
zonar,
geotab-att,
zippy-eld,
evo-eld,
ontime-eld,
dlog-eld,
intelli-shift,
id-eld,
max-eld,
asrit-solutions,
smartelds,
eld-books,
vulcansols,
motion-eld,
blue-horse-eld,
apex-ultima,
radical-eld,
trackease,
rock-eld,
lytx,
blue-ink,
utech,
light-and-travel-eld,
lion-eight,
pop-eld,
netradyne,
people-net,
clear-path-gps,
nexar,
dream-eld,
ez-logz,
first-eld,
rand-mcnally-driver-connect,
rand-mcnally,
mgk-eld,
at-eld,
orient-eld,
noor-eld,
peak-eld,
gorilla-safety,
simplex,
eld-mandate-pro,
allways-track,
aireld,
3pl-tek,
dynamic-eld,
maestral-eld,
alpha-eld,
simba-eld,
ridehub-eld,
sba-eld,
matrack,
apex-eld,
premium-eld,
express-way-eld,
quick-elogs-eld,
drive-safe-eld,
traclog-eld-solutions,
envision-eld,
extreme-eld,
top-compliance-eld,
eblue-sun-logs,
unique-eld,
regulog-eld,
grand-eld,
readyset-pap-eld,
track-ensure,
alfa-eld,
sharp-eld,
ada-eld,
eld-pro-solution,
swift-eld,
club-eld,
protracking-eld,
vista-eld,
zenith-eld,
amber-eld,
smart-drive,
platinum-eld,
green-light-eld,
eld-desired,
lucid-eld,
dsg-elogs,
factor-lucid-eld,
factor-eld-v2,
secure-path-eld,
blue-star-eld,
transit-eld,
zeromax-eld,
usfast-eld,
egreen-eld-v2,
startrucks-eld,
uzbprime-eld,
vitality-eld,
ilog-eld-v2,
daily-eld-plus,
prestige-eld,
leader-eld,
panda-eld,
dyplus-eld,
uspower-eld,
sunset-logbook,
fleetsharp,
aware-gps,
command-gps,
moto-safety,
teletrac-navman-360,
teletrac-navman-director,
redfox-eld,
firstgate-eld,
konexial,
prologs,
ai-eld,
synergy-eld,
route-one-eld,
teletrac-navman,
spireon-fleet-locate,
raven-connected,
rigbot,
truckstaff-eld,
omega-eld,
eld88,
eld99,
dragon-eld,
eldroad,
loop-eld,
eldtrex,
flex-eld,
wizefleet-eld,
pdsinc-eld,
map-elog-corp,
truckford-eld,
highest-eld,
autogri-eld,
simpleway-eld,
logitex,
safe-lane-eld,
zero-eld,
state-elog-v2,
michelin-connected-fleet,
avanguard-eld,
next-fleet-eld
Example:

"geotab"

​
credentials
object
required
​
company
object
​
options
object
​
externalId
string
​
syncMode
enum<string>
default:automatic

Enum values:

  • automatic: Terminal will keep this connections data up to date
  • manual: Terminal will only sync data upon request
Available options:
automatic,
manual
​
backfill
object

Optional backfill to be requested upon successful connection. Will start from NOW if not provided.

​
tags
string[]
​
agreements
AgreementAcceptance · object[]

The agreements to link the connection to.

Response

Created

​
id
string<ulid>
required
Example:

"conn_01GV12VR4DJP70GD1ZBK0SDWFH"

​
company
object
required
​
account
object
required
​
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
  • 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
Available options:
connected,
disconnected,
archived,
pending_deletion,
deleting,
deleted
​
provider
object
required
​
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
​
token
string
required

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

Pattern: ^con_tkn_\S+$
Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

​
options
object
required
​
linkUrl
string<uri>
required

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}"

​
createdAt
string<date-time>
required

ISO 8601 date

Example:

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

​
updatedAt
string<date-time>
required

ISO 8601 date

Example:

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

​
externalId
string

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

Example:

"1234"

​
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"

​
tags
string[]

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

​
filters
object

Filters applied to connection data