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

driverIds
string

Comma separated list of driver IDs to filter for

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
next
string

Cursor used for pagination.