Skip to main content
GET
List HOS Logs

Authorizations

Authorization
string
header
required

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

Headers

X-Application-Id
string

Scopes the request to a Terminal application in the caller's organization. Required for multi-application organizations when using a user session or OAuth access token. API keys are already bound to a single application.

Connection-Token
string
required

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

Pattern: ^con_tkn_\S+$
Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Query Parameters

cursor
string<cursor>

Pagination cursor to start requests from

Pattern: ^[A-Za-z0-9+/=_-]+$
Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

limit
integer

The maximum number of results to return in a page.

startedAfter
string<date-time>

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

Example:

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

startedBefore
string<date-time>

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

Example:

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

modifiedAfter
string<date-time>

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

Example:

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

modifiedBefore
string<date-time>

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. Each ID must use the drv_ prefix.

Pattern: ^drv_[0-9A-HJKMNP-TV-Z]{26}(\s*,\s*drv_[0-9A-HJKMNP-TV-Z]{26})*$
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
deleted
boolean

Show "soft-deleted" records that have been deleted from the provider. Defaults to false.

raw
boolean

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

Response

OK

results
HOS Log · object[]
required
next
string<cursor>

Cursor used for pagination.

Pattern: ^[A-Za-z0-9+/=_-]+$
Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"