Skip to main content
GET
/
v1
/
jobs
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "id": "job_M4qT8YH7xW2pL9nB",
      "status": "pending",
      "url": "<string>",
      "method": "GET",
      "queue": "<string>",
      "attempts": 1,
      "max_attempts": 50,
      "created_at": "2023-11-07T05:31:56Z",
      "required_approval": true,
      "payload": {},
      "headers": {},
      "dedupe_key": "<string>",
      "delay_until": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "finished_at": "2023-11-07T05:31:56Z",
      "next_retry_at": "2023-11-07T05:31:56Z",
      "last_error": "<string>",
      "response_code": 123,
      "response_body": null,
      "duration_ms": 123,
      "approved_at": "2023-11-07T05:31:56Z",
      "approved_by": "<string>",
      "callback_url": "<string>",
      "schedule_id": "sch_TW2qf5b1Ra7mP3Xy",
      "idempotency_key": "<string>",
      "retries_remaining": 1,
      "next_retry_in_seconds": 1,
      "actions": [
        "approve"
      ],
      "deduplicated": true
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 1
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Request-Id
string

Optional client request ID. Echoed back on response.

Query Parameters

​
status
enum<string>
Available options:
pending,
active,
awaiting_approval,
completed,
failed,
cancelled
​
queue
string
​
limit
integer
default:20
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0

Response

Paginated jobs

​
data
object[]
required
​
total
integer
required
Required range: x >= 0
​
limit
integer
required
Required range: 1 <= x <= 100
​
offset
integer
required
Required range: x >= 0