Skip to navigation
Command reference

deel jobs

The Operation column shows the Deel API operation each command calls; the command requires the same token scopes as that operation. Request fields are validated before a request is sent.

CommandOperationDescription
deel jobs listGET /jobsList jobs
deel jobs statusGET /jobs/{job_id}Retrieve a job

All commands accept the global options. Run deel <command> --help --json to output the contract as JSON.

deel jobs list

List jobs.

Calls GET /jobs.

Usage
deel jobs list [GLOBAL OPTIONS]

Options

OptionInTypeRequiredDescription
--cursorquerystringNoCursor for keyset pagination, taken from a previous response page.cursor
--limitqueryintegerNoPage size

Response

The envelope data is an array of objects with the following fields.

FieldTypeDescription
namestringName of the operation.
job_idstringIdentifier of the operation, identical to the job_id returned when it was submitted.
statusstringOverall status of the operation. Allowed values: PENDING, RUNNING, SUCCEEDED, FAILED.
created_atstringWhen the operation was submitted.
created_bystringIdentifier of the user or service that submitted the operation.

Example

deel jobs list
{
  "data": [
    {
      "name": "invoice-adjustment",
      "job_id": "7f3c9b1e-2d84-4a51-9c07-1b5e8a0f3d62",
      "status": "PENDING",
      "created_at": "2026-09-01",
      "created_by": "usr_01H8X3K9"
    }
  ],
  "meta": {
    "request_id": "3f1c9a52-7b04-4e1a-9a8c-2d5f8e1b0c77"
  }
}

deel jobs status

Retrieve a job.

Calls GET /jobs/{job_id}.

Usage
deel jobs status [GLOBAL OPTIONS] --job_id=<string>

Options

OptionInTypeRequiredDescription
--job_idpathstringYesJob identifier

Response

The envelope data is an object with the following fields.

FieldTypeDescription
itemsarrayOne entry per item processed by the operation.
items[].errorobjectError detail when this item failed, absent otherwise.
items[].statusstringStatus of this item. Allowed values: PENDING, RUNNING, SUCCEEDED, FAILED.
items[].external_idstringThe client-supplied id you provided when submitting the item.
job_idstringIdentifier of the job returned when the operation was submitted.
statusstringOverall status of the operation, derived from all items. Allowed values: PENDING, RUNNING, SUCCEEDED, FAILED.

Example

deel jobs status --job_id=7f3c9b1e-2d84-4a51-9c07-1b5e8a0f3d62
{
  "data": {
    "items": [
      {
        "status": "PENDING",
        "external_id": "payroll-2026-09-0001"
      }
    ],
    "job_id": "7f3c9b1e-2d84-4a51-9c07-1b5e8a0f3d62",
    "status": "PENDING"
  },
  "meta": {
    "request_id": "3f1c9a52-7b04-4e1a-9a8c-2d5f8e1b0c77"
  }
}