OPEN API
  1. Hours Of Service
OPEN API
  • Organization Info
    • Get information about your organization
      GET
  • Drivers
    • List all drivers
      GET
    • Retrieve a driver
      GET
  • Hours Of Service
    • Get HOS clocks
      GET
    • Get all driver HOS daily logs
      GET
    • Get HOS logs
      GET
  • Vehicles
    • List all vehicles
      GET
    • Retrieve a vehicle
      GET
  • Vehicle Locations
    • Historical Vehicle Locations
      GET
    • Latest Vehicle Locations
      GET
  • Trips
    • Get Vehicle Trips
      GET
  • Vehicle Stats
    • Vehicle Stats snapshot
      GET
  • Maintenance
    • Get all DVIRs
      GET
  • IFTA
    • Get IFTA jurisdiction reports
      GET
  • Webhook
    • Sample Webhook request for specific trigger
      GET
    • Subscribe to specific immediately events
      POST
    • Available list of Triggers
      GET
    • Unsubscribe form events
      POST
  1. Hours Of Service

Get HOS clocks

GET
https://api.firsteld.com/openapi/hos/available-time/
Hours Of Service
Get the current HOS status for all drivers. This method returns the current HOS status for all drivers in the organization.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
date
string <date>
optional
driverIds
array[string]
required

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.firsteld.com/openapi/hos/available-time/?driverIds'

Responses

🟢200OK
application/json
Body
results
array[object (Result) {4}] 
required
driver
string 
required
codrivers
array
required
availableTime
object (AvailableTime) 
required
currentStatus
enum<string> 
required
offDuty - Off Duty
sleepingBed - Sleeping
driving - Driving
onDuty - On-duty
intermediateW/CLP - Intermediate w/CLP
intermediateW/RLP - Intermediate w/RLP
personalConveyance - Personal Use
yardMove - Yard Move
certification - Certification
login - Login
logout - Logout
enginePowerUpW/CLP - Engine Power-up w/CLP
enginePowerUpW/RLP - Engine Power-up w/RLP
engineShutDownW/CLP - Engine Shut-down w/CLP
engineShutDownW/RLP - Engine Shut-down w/RLP
malfunctionLogged - ELD Malfunction Logged
malfunctionCleared - ELD Malfunction Cleared
diagnosticEventLogged - Data Diagnostic Event Logged
diagnosticEventCleared - Data Diagnostic Event Cleared
Allowed values:
offDutysleepingBeddrivingonDutyintermediateW/CLPintermediateW/RLPpersonalConveyanceyardMovecertificationloginlogoutenginePowerUpW/CLPenginePowerUpW/RLPengineShutDownW/CLPengineShutDownW/RLPmalfunctionLoggedmalfunctionCleareddiagnosticEventLoggeddiagnosticEventCleared
Example
{
  "results": [
    {
      "driver": "string",
      "codrivers": [
        null
      ],
      "availableTime": {
        "cycle": 0,
        "shift": 0,
        "drive": 0,
        "break": 0
      },
      "currentStatus": "offDuty"
    }
  ]
}
Modified at 2025-02-11 21:39:00
Previous
Retrieve a driver
Next
Get all driver HOS daily logs
Built with