Skip to main content
GET
List/Search Routes
Use this to find routes — by date, status, driver, or free-text search — when you have no route ID to start from. The payload is deliberately slim: enough to identify a route and show it in a list, not the whole plan. Read Get Route once you know which one you want. startDate defaults to 30 days ago, so a call with no date range returns the recent past rather than everything you have ever run.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:25
Required range: 1 <= x <= 100
Example:

25

offset
integer
default:0
Required range: x >= 0
Example:

0

sortDirection
string
default:DESC

ASC or DESC, applied to created_at

startDate
string<date-time> | null

Defaults to 30 days ago.

endDate
string<date-time> | null

Defaults to now.

tags
string | null

Comma-separated order tags; matches routes with an order carrying any of them

search
string | null

Free-form search

isDispatched
boolean | null

Filter by dispatched state

dispatchStrategyId
string | null

Comma-separated

pickupStoreLocationIds
string | null

Comma-separated

dropoffStoreLocationIds
string | null

Comma-separated

city
string | null

Comma-separated pickup/dropoff cities

state
string | null

Comma-separated pickup/dropoff states

country
string | null

Comma-separated pickup/dropoff countries

Response

OK

results
RouteListItem · object[]
required
totalCount
integer
required
limit
integer
required
offset
integer
required