List jobs
GET
/api/v1/admin/jobs
const url = 'https://example.com/api/v1/admin/jobs';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/v1/admin/jobs \ --header 'Authorization: Bearer <token>'Lists the jobs. It requires a signed-in User with the admin scope and the admin or owner Role. It can return 401 if the session is missing or expired, 403 if access is denied and 503 if the service is temporarily unavailable. Route: /api/v1/admin/jobs. Inputs: . Safe reads can use bounded retries.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Media typeapplication/json
object
queues
required
Array<object>
object
cancelled_last_day
required
integer
completed_last_day
required
integer
concurrency
required
integer
description
required
string
failed
required
integer
jobs
required
Array<object>
object
cancellation_requested
required
boolean
created_at
required
string
id
required
string
kind
required
string
label
required
string
last_error
string | null
progress_current
integer | null format: int64
progress_message
string | null
progress_total
integer | null format: int64
state
required
string
stoppable
required
boolean
updated_at
required
string
kind
required
string
label
required
string
pause_reason
string | null
paused
required
boolean
paused_at
string | null
registered
required
boolean
running
required
integer
start_missing
required
boolean
waiting
required
integer
Examplegenerated
{ "queues": [ { "cancelled_last_day": 1, "completed_last_day": 1, "concurrency": 1, "description": "example", "failed": 1, "jobs": [ { "cancellation_requested": true, "created_at": "example", "id": "example", "kind": "example", "label": "example", "last_error": "example", "progress_current": 1, "progress_message": "example", "progress_total": 1, "state": "example", "stoppable": true, "updated_at": "example" } ], "kind": "example", "label": "example", "pause_reason": "example", "paused": true, "paused_at": "example", "registered": true, "running": 1, "start_missing": true, "waiting": 1 } ]}