Skip to main content
GET
Get Job

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

job id

Query Parameters

compressedPayload
boolean | null

Return a slimmer job payload by excluding the full quotes and failedQuotes arrays and reducing advancedTask to just {id}. Prefer compressed_payload=true by default for status / ETA / tracking / cancellation flows — it can shrink responses by 10x+ on jobs that shopped many providers. Set to false (or omit) only when the caller needs quote data: pricing breakdowns, provider selection rationale, or failed-dispatch error messages.

Response

OK

A Nash Job.

id
string
required

Job ID

Example:

"job_01234567890"

createdAt
string
required

Created at

Example:

"2023-08-29T19:17:46.264523"

portalUrl
string
required

Portal URL

Example:

"https://usenash.com/portal/job_abc123"

isActive
boolean
required

Is the job active

Example:

true

isBatch
boolean
required

Is the job a batch

Example:

false

jobConfigurations
JobConfigurationsSerializer · object[]
required

Job configurations

externalIdentifier
string | null

External identifier

Example:

"mini-mart-order-99"

jobMetadata
Jobmetadata · object | null

Job metadata

Example:
optionsGroup
OptionsGroupSerializer · object | null

Options group

shortReferenceCode
string | null

7-digit non-unique human-readable reference code for the job.

Example:

"0123456"

selectedConfiguration
Selectedconfiguration · object | null
deprecated

Selected configuration

Example:
jobSpecification
Jobspecification · object | null
deprecated

Job specification

Example:
route
RouteSerializer · object | null

Route