List Devices

GET

devices

curl --request GET \
  --url https://api.withterminal.com/tsp/v1/devices \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'

{
  "results": [
    {
      "id": "dvc_61D9ZWFGHVJ858NBF2Q7DV9MNH",
      "sourceId": "123456789",
      "provider": "geotab",
      "type": "tracker",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "description": "CM31",
      "serialNumber": "1234567890",
      "lastConnectedAt": "2021-01-06T03:24:53.000Z",
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Authorizations

Authorization

string

header

required

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

Headers

Connection-Token

string

required

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

Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Query Parameters

cursor

string

Pagination cursor to start requests from

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

limit

integer

The maximum number of results to return in a page.

modifiedAfter

string

Only include records that were last modified after a provided date.

Example:

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

modifiedBefore

string

Only include records that were last modified before a provided date.

Example:

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

raw

boolean

Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified.

expand

enum<string>

Expand resources in the returned response

Available options:

vehicle

Response

200

application/json

results

object[]

required

results.id

string

required

Example:

"dvc_61D9ZWFGHVJ858NBF2Q7DV9MNH"

results.sourceId

string

required

The ID used to represent the entity in the source system.

Example:

"123456789"

results.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,

gps-tracking-canada,

graybox-solutions,

gridline,

high-point-gps,

io-tab,

blue-arrow,

eagle-wireless,

fleet-complete-hub,

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,

monarch-tracking,

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,

truckx,

tt-eld,

verizon-fleet,

verizon-reveal,

verizon,

webfleet,

xeld,

xplore-eld,

zonar,

geotab-att,

zippy-eld,

evo-eld,

ontime-eld,

intelli-shift,

id-eld,

max-eld,

asrit-solutions,

smartelds,

eld-books,

vulcansols,

motion-eld,

blue-horse-eld,

apex-ultima,

radical-eld,

rock-eld,

lytx,

blue-ink,

utech,

light-and-travel-eld,

lion-eight,

pop-eld,

netradyne,

people-net

Example:

"geotab"

results.type

enum<string>

required

The type of device

Available options:

tracker,

camera

Example:

"tracker"

results.vehicle

The ID of the vehicle that the device is associated with

Example:

"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

results.description

string

The description or model of the device

Example:

"CM31"

results.serialNumber

string

The serial number of the device

Example:

"1234567890"

results.lastConnectedAt

string

The time the device was last connected

Example:

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

results.raw

object[]

List of the raw data used to normalize the common model. Response schemas will vary by provider.

Raw data fetched from the source provider. Most of our endpoints support a raw query parameter that will append a list of the raw requests used to form our common model. This can be helpful for leveraging unique fields that are not part of our unified model.

Example:

[]

string

Cursor used for pagination.

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

List Historical Trips List Safety Events

curl --request GET \
  --url https://api.withterminal.com/tsp/v1/devices \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'

{
  "results": [
    {
      "id": "dvc_61D9ZWFGHVJ858NBF2Q7DV9MNH",
      "sourceId": "123456789",
      "provider": "geotab",
      "type": "tracker",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "description": "CM31",
      "serialNumber": "1234567890",
      "lastConnectedAt": "2021-01-06T03:24:53.000Z",
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

API Reference

Authentication

Vehicles

Drivers

Hours of Service

Trips

Devices

Safety

Groups

Trailers

IFTA

Connections

Data Management

Providers

Issues

Webhook Events

Authorizations

Headers

Query Parameters

Response