Available Time for Drivers

GET

hos

available-time

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

{
  "results": [
    {
      "provider": "geotab",
      "driver": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "currentStatus": "off_duty",
      "availableTime": {
        "cycle": 252000000,
        "shift": 50400000,
        "drive": 39600000,
        "break": 28800000
      },
      "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.

Query Parameters

cursor

string

Pagination cursor to start requests from

limit

integer

The maximum number of results to return in a page.

driverIds

string

Comma separated list of driver IDs to filter for. Can filter up to 50 drivers at a time.

expand

enum<string>

Expand resources in the returned response

Available options:

driver

raw

boolean

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

Response

200

application/json

results

object[]

required

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

results.driver

required

Reference to the driver for this log

results.availableTime

object

required

Available time remaning in milliseconds

results.currentStatus

enum<string>

The current status of the driver

Available options:

off_duty,

sleeper_bed,

driving,

on_duty,

yard_move,

personal_conveyance,

waiting_time

results.raw

object[]

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

string

Cursor used for pagination.

Get Driver List HOS Logs

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

{
  "results": [
    {
      "provider": "geotab",
      "driver": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "currentStatus": "off_duty",
      "availableTime": {
        "cycle": 252000000,
        "shift": 50400000,
        "drive": 39600000,
        "break": 28800000
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

API Reference

Authentication

Vehicles

Drivers

Hours of Service

Trips

Devices

Safety

Groups

Trailers

IFTA

Connections

Data Management

Providers

Issues

Webhook Events

Available Time for Drivers

Authorizations

Headers

Query Parameters

Response