Samsara Hos API is one of 90 APIs that Samsara publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include HOS. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.
This API exposes
6 operations
across 6 paths,
and defines 61 schemas.
It is described by OpenAPI 3.0.1, at version 2024-11-18.
Requests are made against 2 base URLs: https://api.samsara.com/, https://api.eu.samsara.com/.
The identity and technical contract details declared by the specification.
V1ErrorResponse
string
Error message describing why the request failed.
LogMetaDataObjectResponseBody
object
The metadata of the log.
13 properties
HosLogsResponse
object
HOS logs and pagination info.
2 properties
2 required
HosDailyLogsGetHosDailyLogsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
HosDrive
object
Remaining durations for the HOS driving shift limits.
1 property
HosBreak
object
Remaining durations for the HOS rest break requirement.
1 property
time
string
UTC timestamp in RFC 3339 format. Example: 2020-01-27T07:06:25Z.
vehicleTinyResponse
object
A minified vehicle object.
3 properties
HosViolationsGetHosViolationsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
HosDailyLogsGetHosDailyLogsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
HosViolationDayObjectResponseBody
object
2 properties
2 required
VehicleResponseResponseBody
object
A vehicle object
6 properties
HosDailyLogsGetHosDailyLogsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
HosDailyLogsGetHosDailyLogsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
HosDailyLogsGetHosDailyLogsResponseBody
object
2 properties
2 required
DriverWithTimezoneEldSettingsObjectResponseBody
object
The driver the log applies to.
5 properties
2 required
HosClocksForDriver
object
HOS clock values for a specific driver, including remaining times and violations.
5 properties
HosShift
object
Remaining durations and start time for the HOS on duty shift limits.
1 property
GoaPaginationResponseResponseBody
object
Pagination parameters.
2 properties
2 required
standardErrorResponse
object
Error response
2 properties
HosLogsForDrivers
array
List of HOS logs for the specified drivers.
HosDailyLogsGetHosDailyLogsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
HosViolationsGetHosViolationsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
V1HosAuthenticationLogsResponse_authenticationLogs
object
6 properties
HosViolationsGetHosViolationsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DistanceTraveledObjectResponseBody
object
The distance traveled information of the log.
3 properties
HosLogLocation
object
Location associated with the duty status change
2 properties
2 required
HosViolationsGetHosViolationsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
HosViolations
object
Durations the driver has been in violation of HOS rules. See [this page](https://www.samsara.com/fleet/eld-compliance/hours-of-service) for more information on…
2 properties
HosLogsList
array
List of HOS log entries.
HosViolationsObjectResponseBody
object
1 property
1 required
HosClocksForDrivers
array
List of HOS clocks for the specified drivers.
HosViolationObjectResponseBody
object
6 properties
6 required
HosClocksResponse
object
Drivers HOS clocks and pagination info.
2 properties
2 required
HosDailyLogsGetHosDailyLogsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
HosViolationsGetHosViolationsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
HosLogEntry
object
A single HOS log entry.
7 properties
1 required
HosDailyLogsGetHosDailyLogsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
driverTinyResponse
object
A minified driver object.
2 properties
HosDailyLogsGetHosDailyLogsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
V1HosAuthenticationLogsResponse
object
1 property
HosViolationsGetHosViolationsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
PendingDutyStatusDurationsObjectResponseBody
object
What the duty status durations on the drivers log would be if all pending carrier edits are accepted by the driver.
8 properties
HosCycle
object
Remaining durations and start time for the HOS driving cycle.
3 properties
paginationResponse
object
Pagination parameters.
2 properties
2 required
HosClocks
object
Remaining durations and start times (where applicable) for various HOS rules. See [this page](https://www.samsara.com/fleet/eld-compliance/hours-of-service) fo…
4 properties
EldSettingsObjectResponseBody
object
The driver's ELD settings.
1 property
GoaDriverTinyResponseResponseBody
object
A minified driver object. This object is only returned if the route is assigned to the driver.
3 properties
1 required
HosViolationsGetHosViolationsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DutyStatusDurationObjectResponseBody
object
The currently applied duty status durations on the driver's log.
8 properties
DriverRulesetObjectResponseBody
object
5 properties
CurrentDutyStatus
object
The current HOS status type and time the driver started being in this status.
1 property
HosLogsForDriver
object
List of HOS logs for a driver.
2 properties
HosViolationsGetHosViolationsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
HosViolationsGetHosViolationsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
HosDailyLogsGetHosDailyLogsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
HosViolationsGetHosViolationsResponseBody
object
2 properties
2 required
inline_object_1
object
5 properties
1 required
HosViolationsGetHosViolationsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
HosDailyLogsGetHosDailyLogsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
HosDailyLogsObjectResponseBody
object
7 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Samsara publishes across the network.
