v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

List company drivers with Hours of Service (HOS)

get/v1/hours_of_service

Query parameters

driver_ids[]integer[]

Specify 1 or more driver IDs for whom you want to fetch the hours of service.

start_datestring date

Specify the start date from when you want to see the drivers HOS records. Default: TODAY.

end_datestring date

Specify the end date till when you want to see the HOS records. Default: TODAY.

per_pageinteger

Number of records per page.

page_nointeger

Denotes the page number.

Headers

X-Time-Zonestring

Specify the timezone for formatting the timestamps.

X-Metric-Unitsboolean

Specify if you want to use the Metric units or the Imperial units. TRUE: Metric units. FALSE: Imperial Units

X-User-Idinteger

Specify the ID of the Fleet Admin or the Fleet Manager who is accessing this endpoint.

Response

200

Example response

{
  "hours_of_services": [
    {
      "hours_of_service": {
        "id": 47,
        "date": "2016-11-22",
        "off_duty_duration": 43200,
        "on_duty_duration": 7200,
        "driving_duration": 21600,
        "driver": {
          "id": 11,
          "first_name": "Demo",
          "last_name": "Driver",
          "username": "demo_driver",
          "status": "active",
          "role": "driver"
        }
      }
    }
  ],
  "pagination": {
    "per_page": 25,
    "page_no": 1,
    "total": 1
  }
}