Skip to navigation

List jobs

View as Markdown

Lists the jobs of the credential environment, newest first. Needs the scope jobs:read.

Authentication

AuthorizationBearer

An API key (crk_), an exchanged token (crt_) or a JWT of a trusted issuer. The credential needs the scope of the capability. Read the description of each route.

Query parameters

capabilitystringOptional
Only jobs of this capability.
statusenumOptional
Only jobs with this status.
created_afterdatetimeOptional
Jobs created at or after this ISO 8601 time.
created_beforedatetimeOptional
Jobs created before this ISO 8601 time.
cursorstringOptional

The next_cursor of the page before.

limitintegerOptional1-100
The page size, 1 to 100. Default 20.

Response headers

x-request-idstringOptional

The id of the request: req_ and a ULID. Every answer has it.

server-timingstringOptional
The time of the admission.
x-ratelimit-limit-requestsstringOptional
The size of the request bucket, per minute.
x-ratelimit-remaining-requestsstringOptional
The requests that remain.
x-ratelimit-reset-requestsstringOptional
The time until the request bucket is full.
x-ratelimit-limit-unitsstringOptional
The size of the units bucket, per minute. Absent when no limit applies.
x-ratelimit-remaining-unitsstringOptional
The units that remain.
x-ratelimit-reset-unitsstringOptional
The time until the units bucket is full.

Response

One page of jobs.
object"list"
datalist of objects
The jobs of this page, newest first.
next_cursorstring or null
The cursor of the next page, or null on the last page.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error