/legs

List the tenant's legs, newest-created first by default. Every filter is optional. With none, the whole leg set is returned. status narrows to a routing worklist, e.g. status=Unrouted for every leg still awaiting a tour, and may be repeated to union several statuses. from and to bound the legs' creation time. shipmentId or tourId narrows to one shipment's or one tour's legs — the two are mutually exclusive, and either returns the complete matching set in a single page (both are bounded; a shipment carries at most ten legs). Cursor-paginated otherwise: follow cursors.after to fetch the next page.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
enum

The lifecycle status of the legs to list. Omitted means every status. Repeat the parameter to union several statuses, e.g. ?status=Unrouted&status=Failed.

number

Inclusive lower bound on a leg's creation time, as an epoch-milliseconds timestamp. Note the unit: legs are millisecond-stamped, whereas the from / to bounds on /shipments and /tours are epoch seconds and bound a scheduled start rather than a creation time.

number

Inclusive upper bound on a leg's creation time, as an epoch-milliseconds timestamp. See from for the unit caveat.

string

Return only this shipment's legs. Mutually exclusive with tourId.

string

Return only the legs routed on this tour. Mutually exclusive with shipmentId.

string
enum

Sorting direction. Legs are always sorted by creation time; defaults to descending (newest first).

Allowed:
number

Maximum count of items in one page.

string

Opaque pagination cursor from the previous response's cursors.after. Not used when filtering by shipmentId or tourId (those return a single complete page).

Responses

400

Invalid request parameters.

401

Unauthorized - invalid or missing API key.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json