v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB
Job

Get Job by External Identifier

Retrieve a job using your external identifier instead of the Nash job ID. Useful when integrating with external systems that track their own order IDs.

get/v1/jobs/external_identifier/{externalIdentifier}

Path parameters

externalIdentifierstring required

job external identifier

job external identifier

Response

OK

idstring required

Job ID

createdAtstring required

Created at

portalUrlstring required

Portal URL

externalIdentifierstring nullable

External identifier

jobMetadataobject nullable

Job metadata

isActiveboolean required

Is the job active

isBatchboolean required

Is the job a batch

shortReferenceCodestring nullable

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

selectedConfigurationobject nullable

Selected configuration

jobSpecificationobject nullable

Job specification