API reference
Every endpoint, parameter and field in the Harlo API, v1.
Base URL https://harlo-api-dev.pages.dev/v1. Every endpoint is a GET, takes your key as a Bearer token, and returns JSON (or CSV with format=csv on a list). Description version 2026-11-14.
| Endpoint | What it returns |
|---|---|
/v1/me | The key you're using and its workspace. |
Loads/v1/loads, /v1/loads/{id} | Loads with their stops, routes, rate and invoice. |
Invoices/v1/invoices, /v1/invoices/{id} | Customer invoices, with lines, amount paid and balance. |
Payments/v1/payments, /v1/payments/{id} | Payments received against invoices. |
Customers/v1/customers, /v1/customers/{id} | The shippers and brokers you haul for or bill. |
Drivers/v1/drivers, /v1/drivers/{id} | Your drivers, with license and medical card dates and pay settings. |
Equipment/v1/equipment, /v1/equipment/{id} | Tractors and trailers. |
Carriers/v1/carriers, /v1/carriers/{id} | Carriers in a brokerage's network, with authority and insurance. |
Facilities/v1/facilities, /v1/facilities/{id} | Pickup and delivery locations. |
Documents/v1/documents, /v1/documents/{id} | Files attached to loads and records. Retrieve one for a download link. Identity, medical and bank documents are never returned. |
Events/v1/events, /v1/events/{id} | The activity log: what changed, when, and who did it. |
OpenAPI
The whole API is described in OpenAPI 3.1 at https://harlo-api-dev.pages.dev/v1/openapi.json. Import it into Postman, Insomnia or a code generator to get a ready-made client. It needs no key.
Conventions
- Ids are UUIDs.
numberis the human number you see in Harlo, likeL-00042. - Timestamps are ISO 8601 in UTC. Dates (
due_date,expires_on) have no time. - Stop appointments are in the stop's local time, with its
timezonealongside; actual arrival and departure are UTC timestamps. - Money is a number in the record's
currency(USD unless stated), to the cent. - A field with no value is
null. New fields may appear; ignore ones you don't know.