GET
/
hos
/
available-time
Available Time for Drivers
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.

Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Query Parameters

​
cursor
string<cursor>

Pagination cursor to start requests from

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

​
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

OK

The response is of type object.