NAnash
Job

List/Search Jobs

List jobs (deliveries) with filters, sorting, and pagination. Returns a slim payload suitable for discovery; use GET /v1/jobs/<id> for full details.

get/v1/jobs

Request

  • Base URL
    https://api.sandbox.usenash.com
  • Auth
    none declared

Query parameters

limitinteger
Example:25
offsetinteger
sortBystring

Sort field (e.g. created_at, pickup_start_time)

sortDirectionstring

ASC or DESC

startDatestring date-time nullable

Defaults to 3 days ago.

endDatestring date-time nullable

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

deliveryStatusesstring nullable

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

providerNamesstring nullable

Comma-separated provider names

courierNamesstring nullable

Comma-separated courier names

tagsstring nullable

Comma-separated job tags

packageTagsstring nullable

Comma-separated package tags

pickupStoreLocationIdsstring nullable

Comma-separated

dropoffStoreLocationIdsstring nullable

Comma-separated

searchstring nullable

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).

shortReferenceCodestring nullable

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.

customerNamestring nullable

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.

isBatchboolean nullable

Filter to batch jobs only

hasNotesboolean nullable

Filter to jobs with notes

citystring nullable

Comma-separated pickup/dropoff cities

statestring nullable

Comma-separated pickup/dropoff states

countrystring nullable

Comma-separated pickup/dropoff countries

Response

OK

totalCountinteger required
limitinteger required
offsetinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.