OPEN API
  1. Drivers
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. Drivers

List all drivers

GET
/openapi/drivers/
Drivers
Get all drivers in organization.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
modifiedAfter
string <date-time>
optional
2024-05-22T01:40:16.274753Z
modifiedBefore
string <date-time>
optional
2024-05-22T01:40:16.274753Z
page
integer 
optional
A page number within the paginated result set.
page_size
integer 
optional
Number of results to return per page.

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 'http://127.0.0.1:8001/openapi/drivers/'

Responses

🟢200OK
application/json
Body
count
integer 
optional
Example:
10
page_size
integer 
optional
Example:
123
previous
integer  | null 
optional
Example:
null
current
integer 
optional
Example:
1
next
integer  | null 
optional
Example:
2
results
array[object (Driver) {8}] 
optional
id
string <uuid>
read-onlyrequired
ID Vehicle State
status
string 
read-onlyrequired
Status of the driver
username
string 
required
Driver username
firstName
string 
required
Driver first name
lastName
string 
required
Driver last name
email
string 
required
Driver email
phone
string 
required
Driver phone number
license
object 
read-onlyrequired
Driver license number
Example
{
  "count": 10,
  "page_size": 123,
  "previous": null,
  "current": 1,
  "next": 2,
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "string",
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string",
      "license": {
        "state": "string",
        "number": "string"
      }
    }
  ]
}
Modified at 2025-04-23 00:31:51
Previous
Get information about your organization
Next
Retrieve a driver
Built with