GET
/
hos
/
logs
List HOS Logs
curl --request GET \
  --url https://api.withterminal.com/tsp/v1/hos/logs \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'
{
  "results": [
    {
      "id": "hos_log_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "sourceId": "123456789",
      "provider": "geotab",
      "status": "off_duty",
      "driver": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "codrivers": [
        "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ],
      "startedAt": "2021-01-06T03:24:53.000Z",
      "endedAt": "2021-01-06T03:24:53.000Z",
      "location": {
        "longitude": -122.4194155,
        "latitude": 37.7749295
      },
      "remarks": [
        {
          "sourceId": "123456789",
          "submittedAt": "2021-01-06T03:24:53.000Z",
          "notes": "<string>"
        }
      ],
      "metadata": {
        "addedAt": "2023-11-07T05:31:56Z",
        "modifiedAt": "2023-11-07T05:31:56Z"
      },
      "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.

​
startedAfter
string

Only include records of statuses that started after a provided date.

Example:

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

​
startedBefore
string

Only include records of statuses that started before a provided date.

Example:

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

​
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"

​
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,
vehicle,
codrivers,
driver,vehicle,
driver,codrivers,
vehicle,driver,
vehicle,codrivers,
codrivers,driver,
codrivers,vehicle,
driver,vehicle,codrivers,
driver,codrivers,vehicle,
vehicle,driver,codrivers,
vehicle,codrivers,driver,
codrivers,driver,vehicle,
codrivers,vehicle,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.

GET
/
hos
/
logs
List HOS Logs
curl --request GET \
  --url https://api.withterminal.com/tsp/v1/hos/logs \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'
{
  "results": [
    {
      "id": "hos_log_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "sourceId": "123456789",
      "provider": "geotab",
      "status": "off_duty",
      "driver": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "codrivers": [
        "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ],
      "startedAt": "2021-01-06T03:24:53.000Z",
      "endedAt": "2021-01-06T03:24:53.000Z",
      "location": {
        "longitude": -122.4194155,
        "latitude": 37.7749295
      },
      "remarks": [
        {
          "sourceId": "123456789",
          "submittedAt": "2021-01-06T03:24:53.000Z",
          "notes": "<string>"
        }
      ],
      "metadata": {
        "addedAt": "2023-11-07T05:31:56Z",
        "modifiedAt": "2023-11-07T05:31:56Z"
      },
      "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.

​
startedAfter
string

Only include records of statuses that started after a provided date.

Example:

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

​
startedBefore
string

Only include records of statuses that started before a provided date.

Example:

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

​
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"

​
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,
vehicle,
codrivers,
driver,vehicle,
driver,codrivers,
vehicle,driver,
vehicle,codrivers,
codrivers,driver,
codrivers,vehicle,
driver,vehicle,codrivers,
driver,codrivers,vehicle,
vehicle,driver,codrivers,
vehicle,codrivers,driver,
codrivers,driver,vehicle,
codrivers,vehicle,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.