Customers
The shippers and brokers you haul for or bill.
List customers
GET/v1/customers
Newest first, a page at a time. See Pagination and syncing.
curl "https://harlo-api-dev.pages.dev/v1/customers?limit=10" \
-H "Authorization: Bearer $HARLO_API_KEY"Filters
| Parameter | What it does |
|---|---|
status | Only customers in this status. |
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 customer
GET/v1/customers/{id}
curl "https://harlo-api-dev.pages.dev/v1/customers/f96a1a46-3469-450a-8a70-4e16e433b248" \
-H "Authorization: Bearer $HARLO_API_KEY"Example response
{
"id": "f96a1a46-3469-450a-8a70-4e16e433b248",
"object": "customer",
"number": "C-0001",
"name": "Blue Lake Logistics LLC",
"dba": null,
"type": "brokerage",
"status": "prospect",
"email": "loads@bluelake.example",
"billing_email": null,
"phone": "(312) 555-0141",
"phone_ext": null,
"mc_number": 778812,
"dot_number": null,
"scac": null,
"payment_terms": null,
"payment_method": null,
"invoice_method": null,
"credit_limit": null,
"credit_status": "compliant",
"accounting_id": null,
"tax_id_on_file": false,
"parent_customer_id": null,
"address": {
"line1": "1200 W Lake St",
"city": "Chicago",
"state": "IL",
"postal_code": "60607",
"country": "US",
"formatted": "1200 W Lake St Chicago, IL 60607",
"latitude": null,
"longitude": null
},
"created_at": "2026-11-14T06:23:17.581258+00:00",
"updated_at": "2026-11-14T06:23:17.581258+00:00"
}The customer object
| Field | Type | What it is |
|---|---|---|
id | id | Unique id of the customer. |
object | string | Always "customer". |
number | string, nullable | Your customer number, e.g. C-0001. |
name | string | |
dba | string, nullable | |
type | string, nullable | shipper, brokerage, ... |
status | string, nullable | |
email | string, nullable | |
billing_email | string, nullable | |
phone | string, nullable | |
phone_ext | string, nullable | |
mc_number | integer, nullable | |
dot_number | integer, nullable | |
scac | string, nullable | |
payment_terms | string, nullable | |
payment_method | string, nullable | |
invoice_method | string, nullable | |
credit_limit | number, nullable | |
credit_status | string, nullable | |
accounting_id | string, nullable | The customer's id or name in your accounting system, set in Harlo on the customer's Profile tab (Billing, Accounting System ID). Use it to match records. |
tax_id_on_file | boolean | Whether a tax id is on file. The id itself is never returned. |
parent_customer_id | id, nullable | |
address | object | |
line1 | string, nullable | |
city | string, nullable | |
state | string, nullable | |
postal_code | string, nullable | |
country | string, nullable | |
formatted | string, nullable | The whole address on one line. |
latitude | number, nullable | |
longitude | number, nullable | |
created_at | timestamp, nullable | When it was created. |
updated_at | timestamp, nullable | When it last changed. Use with `updated_since` to sync. |