Sign in
Job Statuses

List Job Statuses

Shows the statuses for background jobs. Statuses are sorted first by completion date and then by creation date in descending order.

Allowed For:

  • Agents

Pagination

  • Cursor pagination

See Pagination.

get/api/v2/job_statuses

Query parameters

page[before]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[after]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[size]integer

Specifies how many records should be returned in the response. You can specify up to 100 records per page.

Response

Success Response

Example response

{
  "job_statuses": [
    {
      "id": "82de0b044094f0c67893ac9fe64f1a99",
      "message": "Completed at 2018-03-08 10:07:04 +0000",
      "progress": 2,
      "results": [
        {
          "action": "update",
          "id": 244,
          "status": "Updated",
          "success": true
        },
        {
          "action": "update",
          "id": 245,
          "status": "Updated",
          "success": true
        }
      ],
      "status": "completed",
      "total": 2,
      "url": "https://example.zendesk.com/api/v2/job_statuses/82de0b0467893ac9fe64f1a99.json"
    }
  ]
}

Changes