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 '{
  "company": {
    "name": "<string>",
    "dotNumbers": [
      "<string>"
    ]
  },
  "options": {
    "ingestHistoryFromSourceSystem": true
  },
  "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"
  },
  "externalId": "1234",
  "sourceId": "123456789",
  "syncMode": "automatic",
  "token": "con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4",
  "tags": [
    "Tag Name"
  ],
  "options": {
    "ingestHistoryFromSourceSystem": true
  },
  "filters": {
    "vehicles": {
      "status": "active",
      "excludeIds": [
        "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ],
      "includeIds": [
        "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ]
    },
    "drivers": {
      "status": "active",
      "excludeIds": [
        "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ],
      "includeIds": [
        "drv_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"
}
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
  • 3PL TEK
  • ABC ELD
  • Action ELD
  • ADA ELD
  • Advantage Knights ELD
  • Advantage One
  • AirELD
  • Alfa ELD
  • Allways Track
  • Alpha E-Logbook
  • Amber ELD
  • AMPM ELD
  • Apex ELD
  • Apex Ultima
  • Apollo
  • Apollo Compass
  • Apollo ELD
  • Argos Connected Solutions
  • AT ELD
  • Attrix
  • AwareGPS
  • Azuga
  • BigRoad
  • Bison Elog
  • Black Bear
  • Blue Arrow Telematics
  • Blue Horse ELD
  • Blue Ink Tech
  • Blue Star ELD
  • Captain ELD
  • ClearPathGPS
  • Club ELD
  • Cobra ELD
  • Columbus ELD
  • CommandGPS
  • Conti-GO
  • Coretex
  • Daily ELD
  • Daily ELD Plus
  • DFL ELD
  • Digital ELD
  • DLog ELD
  • Dream ELD
  • DriveSafe ELD
  • DSG Elogs
  • DY ELD
  • DY+ ELD
  • Dynamic ELD
  • Eagle Wireless
  • eBlue Sun Logs
  • Egreen ELD
  • Egreen ELD (Lucid)
  • ELD Books
  • ELD Connection
  • ELD Desired
  • ELD for You
  • ELD Mandate
  • ELD Mandate HOS
  • ELD Mandate Plus
  • ELD Mandate Prime
  • ELD Mandate Pro
  • ELD One
  • ELD Pro Solution
  • ELD Rider
  • ELD2GO
  • ELD4Trucking
  • Elog42
  • Empire Logs
  • Envision ELD
  • EnVue Telematics
  • EROAD
  • EVA ELD
  • EVO ELD
  • Express Way ELD
  • Extreme ELD
  • Ezlogz
  • Factor ELD
  • Factor ELD (Lucid)
  • First ELD
  • Flash ELogs
  • Fleet Complete Hub
  • Fleet Profit Center
  • Fleetistics
  • FleetSharp
  • FM ELD
  • Fort Knox ELD
  • Forza ELD
  • Geotab
  • Geotab AT&T
  • Globcom ELD
  • GoFleet
  • GoGPS
  • GPS Insight
  • GPS Tracking Canada
  • GPSTab
  • Grand ELD
  • GrayBox Solutions
  • Green Light ELD
  • Gridline
  • GT ELD
  • Hero ELD
  • High Point GPS
  • HOS Reporter Plus
  • HOS247
  • ID ELD
  • ILog ELD
  • ILog ELD (Lucid)
  • Infinity ELD
  • IntelliShift
  • IoTab
  • Ironman ELD
  • ISAAC Instruments
  • Just ELD
  • KSK ELD
  • Leader ELD
  • Legacy ELD
  • Light & Travel ELD
  • Linxup
  • Log Plus ELD
  • Lucid ELD
  • Lytx
  • Maestral ELD
  • MasterELD
  • Matrack
  • MAX ELD
  • MGK ELD
  • Monarch Tracking
  • Moonlight ELD
  • Motion ELD
  • Motive
  • MOTOsafety
  • Mountain ELD
  • MyWay ELD
  • Netradyne
  • Nexar
  • Noor ELD
  • Novio ELD
  • Omnitracs
  • Omnitracs ES
  • Omnitracs XRS
  • OneStep GPS
  • Ontime ELD
  • Optima ELD
  • Orient ELD
  • Orient Star ELD
  • Panda ELD
  • Paragon ELD
  • Peak ELD
  • PeopleNet
  • Phoenix ELD
  • Pioneer ELD Solution
  • Platinum ELD
  • PoP ELD
  • PowerTrucks ELD
  • Premium ELD
  • Prestige ELD
  • Pro Ride ELD
  • Project ELD
  • ProTracking ELD
  • PTI ELD
  • Quick Elogs ELD
  • Radical ELD
  • Rand McNally
  • Rand McNally DriverConnect
  • ReadySet Papeld
  • RealELD
  • Regulog ELD
  • Reliable ELD
  • Renaissance ELD
  • Ridehub ELD
  • Right Trucking
  • RoadStar
  • Robinhood ELD
  • Rock ELD
  • Route ELD
  • RouteMate
  • Run ELD
  • Samsara
  • Sandbox
  • SBA ELD
  • Secure Path ELD
  • SF ELD
  • Sharp ELD
  • Simba ELD
  • Simplex ELD2Go
  • Smart Choice Logs
  • SmartDrive
  • Smartelds
  • Solution ELD
  • Sparkle ELD
  • Speedline ELD
  • SR ELD
  • Startrucks ELD
  • Starway ELD
  • State ELOG
  • Sunset Logbook
  • Support ELD
  • Surfsight
  • Swift ELD
  • Switchboard
  • Teddy ELD
  • Teletrac Navman Director
  • Tempus ELD
  • TFM ELD
  • Top Compliance ELD
  • Top Tracking System
  • Track Truck ELD
  • TrackEnsure
  • Traclog ELD Solutions
  • Transflo
  • Transit ELD
  • TruckX
  • True Road ELD
  • Trust ELD
  • TT ELD
  • TX ELD
  • Under Control ELD
  • Unique ELD
  • Unity ELD
  • USfast ELD
  • UzbPrime ELD
  • Verizon Connect
  • Verizon Connect Fleet
  • Verizon Connect Reveal
  • Vista ELD
  • Vitality ELD
  • Vlog ELD
  • Vulcansols
  • WBCS Group LLC
  • Webfleet
  • XELD
  • Xpert Logs
  • Xplore ELD
  • YouLog ELD
  • Zaphira ELD
  • Zenith ELD
  • Zeromax ELD
  • Zippy ELD
  • Zonar
provider
enum<string>
required
Available options:
3pl-tek
credentials
object
required
company
object
options
object
  • Omnitracs Options
  • Omnitracs ES Options
  • Omnitracs XRS Options
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
Available options:
connected,
disconnected,
archived,
pending_deletion
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.

Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

options
object
required
  • Omnitracs Options
  • Omnitracs ES Options
  • Omnitracs XRS Options

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
Example:

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

updatedAt
string<date-time>
required
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

I