Skip to navigation

deel job

The job commands follow asynchronous operations by id and accept several job ids in one call. To paginate results, use the jobs commands. See Asynchronous jobs for the workflow.

CommandDescription
deel job statusFetch one or more jobs by id
deel job listList recent jobs

Both commands accept the global options.

deel job status

Fetch the status and per-item results of one or more jobs.

Usage
deel job status <id>[,<id>...] [GLOBAL OPTIONS]

Arguments

ArgumentRequiredDescription
idYesOne job id, or several separated by commas

Response

data is a single job object for one id, or an array of job objects for several ids, in the order given.

FieldTypeDescription
job_idstringThe job identifier
statusstringDerived from all items: PENDING, RUNNING, SUCCEEDED, or FAILED
itemsarrayOne entry per item processed by the job
items[].external_idstringThe id you provided when submitting the item, when present
items[].statusstringStatus of this item: PENDING, RUNNING, SUCCEEDED, or FAILED
items[].errorobjectError detail when this item failed, absent otherwise

This is the same job data deel jobs status returns; job status additionally accepts several comma-separated ids.

Errors

CodeCause
usage.jobNo id was given
job.not_foundNo job found for that id
job.errorThe job lookup returned an error status

Examples

deel job status 7f3c9b1e-2d84-4a51-9c07-1b5e8a0f3d62
deel job status 7f3c9b1e-2d84-4a51-9c07-1b5e8a0f3d62,9a10c2d4-8e35-4a92-b6f1-7c3d9e5a2b18 --fields job_id,status
deel jobs status --job_id=7f3c9b1e-2d84-4a51-9c07-1b5e8a0f3d62 --jq '.items[] | select(.status == "FAILED")'

deel job list

List recent jobs for the authenticated account.

Usage
deel job list [GLOBAL OPTIONS]

Response (data array)

FieldTypeDescription
job_idstringThe job identifier
namestringThe operation that created the job
statusstringPENDING, RUNNING, SUCCEEDED, or FAILED
created_atstringISO 8601 creation timestamp
created_bystringThe user or token that created the job

Example

deel job list --jq '.[] | select(.status == "RUNNING") | .job_id' --raw

For pagination parameters (--limit, --cursor), use deel jobs list.