Jobs
List jobs, newest first
GET /v1/jobs: List jobs, newest first
GET /v1/jobs
| Operation id | listJobs |
| Key scope | read: every key |
| Section | Jobs |
#Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer | ≥ 1 · ≤ 100 · default 25 | |
cursor | query | string | min length 1 | |
status | query | enum (7 values) | one of "queued", "running", "awaiting_input", "needs_attention", "succeeded", "failed", "canceled" | |
program | query | string | min length 1 | |
tag | query | string | min length 1 | |
batch | query | string | pattern ^bat_[0-9a-hjkmnp-tv-z]{26}$ | |
schedule | query | string | pattern ^sch_[0-9a-hjkmnp-tv-z]{26}$ | |
created_after | query | string (date-time) | ||
created_before | query | string (date-time) | ||
mode | query | "live", "test" |
#Example request
curl -X GET "https://api.kaab.ist/v1/jobs" \
-H "Authorization: Bearer $KAAB_API_KEY"
#Responses
#200
Job page
| Field | Type | Required | Description |
|---|---|---|---|
data | Job | yes | |
next_cursor | string or null | yes |
#Errors
Every error answers with the error envelope; its code is one of the error codes.
| Status | When |
|---|---|
| 400 | request_invalid: request validation failed |
| 401 | Missing or invalid API key |
| 403 | The key's scope does not cover this operation |
| 429 | Rate limited; see Retry-After |
| 500 | internal: unexpected server error |