Skip to content
DevelopersGet an API key

Facilities

Pickup and delivery locations.

List facilities

GET/v1/facilities

Newest first, a page at a time. See Pagination and syncing.

curl "https://harlo-api-dev.pages.dev/v1/facilities?limit=10" \
  -H "Authorization: Bearer $HARLO_API_KEY"

Paging, order and format

ParameterWhat it does
limitHow many to return, 1 to 100.Default: 25
cursor`next_cursor` from the previous page.
sortOrder: newest first by default.Values: -created_at, created_at, -updated_at, updated_atDefault: -created_at
updated_sinceOnly records changed at or after this ISO 8601 time.
created_sinceOnly 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 facility

GET/v1/facilities/{id}

curl "https://harlo-api-dev.pages.dev/v1/facilities/ca799378-f757-4bb2-8b55-6a64a3d07ec9" \
  -H "Authorization: Bearer $HARLO_API_KEY"
Example response
{
  "id": "ca799378-f757-4bb2-8b55-6a64a3d07ec9",
  "object": "facility",
  "number": "F-0002",
  "name": "Gulf Coast Grocers",
  "type": "warehouse",
  "status": "onboarding",
  "timezone": "America/Chicago",
  "appointment_required": false,
  "contact": {
    "name": null,
    "phone": null,
    "email": null
  },
  "address": {
    "line1": "4200 Irving Boulevard",
    "city": "Dallas",
    "state": "TX",
    "postal_code": "75247",
    "country": "USA",
    "formatted": "4200 Irving Boulevard, Dallas, TX, USA",
    "latitude": 32.807353,
    "longitude": -96.888234
  },
  "created_at": "2026-11-14T06:23:27.996808+00:00",
  "updated_at": "2026-11-14T06:23:28.604471+00:00"
}

The facility object

FieldTypeWhat it is
ididUnique id of the facility.
objectstringAlways "facility".
numberstring, nullable
namestring
typestring, nullable
statusstring, nullable
timezonestring, nullable
appointment_requiredboolean, nullable
contactobject
namestring, nullable
phonestring, nullable
emailstring, nullable
addressobject
line1string, nullable
citystring, nullable
statestring, nullable
postal_codestring, nullable
countrystring, nullable
formattedstring, nullableThe whole address on one line.
latitudenumber, nullable
longitudenumber, nullable
created_attimestamp, nullableWhen it was created.
updated_attimestamp, nullableWhen it last changed. Use with `updated_since` to sync.
NextDocuments