Terminal home page

Get Started
Get Started

Drivers

List Drivers

Documentation
API Reference
Website
Product Roadmap

Drivers

List Drivers

List all of the drivers in the connected account

GET

drivers

Authorization

string

Bearer

Authorization

Required

string

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

Connection-Token

string

Connection-Token

Required

string

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

Add Example Value

cursor

string

cursor

string

Pagination cursor to start requests from

Add Example Value

limit

integer

limit

integer

The maximum number of results to return in a page.

modifiedAfter

string

modifiedAfter

string

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

Add Example Value

modifiedBefore

string

modifiedBefore

string

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

Add Example Value

raw

boolean

raw

boolean

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

expand

enum<string>

expand

enum<string>

Expand resources in the returned response

Authorizations

Authorization

string

headerrequired

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.

Query Parameters

cursor

string

Pagination cursor to start requests from

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.

modifiedBefore

string

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

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:

groups

Response

200 - application/json

results

object[]

required

results.id

string

required

results.sourceId

string

required

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

results.provider

enum<string>

required

Available options:

azuga,

bigroad,

conti-go,

eld-mandate,

eld-mandate-plus,

eld-rider,

eldone,

envue-telematics,

eroad,

fleet-complete-hub,

fleetistics,

fort-knox,

fm-eld,

geotab,

gofleet,

gogps,

gps-insight,

gpstab,

isaac,

ksk,

linxup,

coretex-360,

apollo,

apollo-eld,

apollo-compass,

eld-mandate-prime,

hos-reporter-plus,

master-eld,

monarch-tracking,

motive,

mountain-eld,

omnitracs-es,

omnitracs-xrs,

omnitracs,

optima-eld,

pro-ride-eld,

pti-eld,

real-eld,

right-trucking,

roadstar,

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

results.status

enum<string>

required

The status in the providers system

Available options:

active,

inactive

results.firstName

string

results.middleName

string

results.lastName

string

results.email

string

results.phone

string

Phone number formatted in E.164 formatting

results.license

object

results.license.state

enum<string>

US State or Canadian Province

Available options:

AL,

AK,

AS,

AZ,

AR,

CA,

CO,

CT,

DE,

FL,

GA,

GU,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MP,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

OH,

OK,

OR,

PA,

PR,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

WA,

WV,

WI,

WY,

VI,

AB,

BC,

MB,

NB,

NL,

NS,

ON,

PE,

QC,

SK,

NT,

NU,

UM,

YT,

DC

results.license.number

string

results.groups

array

results.raw

object[]

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

results.raw.provider

string

required

results.raw.schema

string

required

results.raw.extractedAt

string

required

ISO 8601 date

results.raw.data

object

required

string

Cursor used for pagination.

Historical Vehicle Stats Get Driver

website linkedin

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