Skip to main content
GET
List/Search Jobs

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

sortBy
string
default:created_at

Sort field (e.g. created_at, pickup_start_time)

sortDirection
string
default:DESC

ASC or DESC

startDate
string<date-time> | null

Defaults to 3 days ago.

endDate
string<date-time> | null

Defaults to 7 days from now so in-flight and scheduled deliveries are included.

deliveryStatuses
string | null

Comma-separated delivery statuses (e.g. created,accepted_by_courier,delivered)

providerNames
string | null

Comma-separated provider names

courierNames
string | null

Comma-separated courier names

tags
string | null

Comma-separated job tags

packageTags
string | null

Comma-separated package tags

pickupStoreLocationIds
string | null

Comma-separated

dropoffStoreLocationIds
string | null

Comma-separated

search
string | null

Free-form search across IDs, external identifiers, short reference codes, addresses, and courier/customer names. For an exact match on a single field, use the dedicated filter (e.g. short_reference_code).

shortReferenceCode
string | null

Exact match on the 7-digit short reference code shown on delivery cards. Codes are non-unique; multiple jobs may be returned. When provided, the default date window is widened to 90 days so older jobs are discoverable.

customerName
string | null

Fuzzy, case-insensitive substring match on the end customer's name (pickup or dropoff full name) over the denormalized task. Use this to locate a delivery when the caller only knows the customer's name. Matches names only — not business names, addresses, or courier names (use search for broader free-form matching). When provided, the default date window is widened to 90 days so older deliveries are discoverable.

isBatch
boolean | null

Filter to batch jobs only

hasNotes
boolean | null

Filter to jobs with notes

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
JobListItem · object[]
required
totalCount
integer
required
limit
integer
required
offset
integer
required