Drivers
Your drivers, with license and medical card dates and pay settings.
List drivers
GET/v1/drivers
Newest first, a page at a time. See Pagination and syncing.
curl "https://harlo-api-dev.pages.dev/v1/drivers?limit=10" \
-H "Authorization: Bearer $HARLO_API_KEY"Filters
| Parameter | What it does |
|---|---|
employment_status | e.g. active, onboarding, terminated. |
Paging, order and format
| Parameter | What it does |
|---|---|
limit | How many to return, 1 to 100.Default: 25 |
cursor | `next_cursor` from the previous page. |
sort | Order: newest first by default.Values: -created_at, created_at, -updated_at, updated_atDefault: -created_at |
updated_since | Only records changed at or after this ISO 8601 time. |
created_since | Only records created at or after this ISO 8601 time. |
format | `csv` returns the page as a spreadsheet: nested fields become columns like `customer.name`.Values: json, csvDefault: json |
Retrieve a driver
GET/v1/drivers/{id}
curl "https://harlo-api-dev.pages.dev/v1/drivers/57ab2b72-fa01-4a35-bd1c-7569b77ad8ea" \
-H "Authorization: Bearer $HARLO_API_KEY"Example response
{
"id": "57ab2b72-fa01-4a35-bd1c-7569b77ad8ea",
"object": "driver",
"number": "D-0001",
"first_name": "Maria",
"last_name": "Alvarez",
"type": "company",
"employment_status": "active",
"dispatch_status": "on_load",
"compliance_status": "compliant",
"start_date": null,
"end_date": null,
"pay": {
"type": null,
"rate": null,
"frequency": null
},
"license": {
"state": "IL",
"class": "cdl_a",
"status": "ACTIVE",
"expires_on": "2028-05-31"
},
"medical_card_expires_on": "2027-08-15",
"created_at": "2026-11-14T06:15:32.702648+00:00",
"updated_at": "2026-11-14T06:58:45.759216+00:00"
}The driver object
| Field | Type | What it is |
|---|---|---|
id | id | Unique id of the driver. |
object | string | Always "driver". |
number | string, nullable | e.g. D-0001. |
first_name | string, nullable | |
last_name | string, nullable | |
type | string, nullable | company, owner_operator, ... |
employment_status | string, nullable | |
dispatch_status | string, nullable | |
compliance_status | string, nullable | |
start_date | date, nullable | |
end_date | date, nullable | |
pay | object | |
type | string, nullable | |
rate | number, nullable | |
frequency | string, nullable | |
license | object, nullable | |
state | string, nullable | |
class | string, nullable | |
status | string, nullable | |
expires_on | date, nullable | |
medical_card_expires_on | date, nullable | |
created_at | timestamp, nullable | When it was created. |
updated_at | timestamp, nullable | When it last changed. Use with `updated_since` to sync. |