API ReferenceLocations

List Locations

Returns a paginated list of locations for the authenticated business. Results are sorted by name ascending. Optionally filter by location type. Only `WAREHOUSE` and `TRUCK` locations are returned. Jobs (`JOB`) are served by the Jobs API — see `GET /jobs`. Passing `type=JOB` or any unrecognized `type` value returns `400`. Requires scope: `locations:read`

Authentication

API_KEYstring
API Key authentication via header

Query parameters

pageintegerOptional

Zero-based page index. Defaults to 0.

sizeintegerOptional

Items per page. Defaults to 20, maximum 100.

typeenumOptional

Filter by location type. Must be WAREHOUSE or TRUCK. JOB is rejected with 400 — use the Jobs API to list jobs. Returns 400 if an unrecognized value is provided.

Allowed values:
sortstringOptional

Sort by field,direction (Spring Pageable format; direction asc or desc, default asc). Allowed fields: id, name, type, plateNumber, number, archived, active, createdAt, updatedAt. Default order (when no sort is supplied): pinned locations first, then least-recently-updated.

Response

This endpoint returns an object.
datalist of objects
paginationobject
Pagination metadata returned on all list endpoints.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error