Skip to main content
GET
List jobs

What it costs

The key needs jobs:read. The call is free. The answer is 200 with JobPage.

Paging

page_size from 1, default 50, maximum 200, a larger value lowered with the notice page_size_lowered; page_token is opaque, bound to its query, alive 24 hours; next_page_token is absent on the last page, and a page that carries it holds at least one job. A changed filter between pages, page_size excepted, or an unknown, expired or another list’s token, is 400 page-token-invalid.

Refused before any work

A value outside its set or range, page_size above its maximum excepted, which is lowered: 400 invalid-request, not_allowed or bound, each with where it is. A token of another list: 400 page-token-invalid. An unknown query parameter: 400 invalid-request, unknown_field.

Notices this operation makes

page_size_lowered, in JobPage.notices; a Job carries no notices and no version, so no retirement notice is made here.

Problem types

  • 400 invalid-request, The request is invalid; page-token-invalid, The page token is invalid.
  • 401 unauthorized, The key is missing or rejected.
  • 403 insufficient-scope, The key lacks a scope this call needs.
  • 429 rate-limit-exceeded, The rate limit is exceeded; concurrency-limit-exceeded, Too many calls are in flight.
  • 500 internal-error, The service failed.
  • 503 overloaded, The service is overloaded.

Authorizations

Authorization
string
header
required

An API key from https://app.getclean.ai, or an access token issued by https://auth.getclean.ai/realms/getclean, sent as Authorization: Bearer <key> on every call. The scopes a key carries and what a 401 and a 403 say are on the keys and sign-in page.

Headers

traceparent
string

Your own trace id for the call, the W3C Trace Context traceparent header, optional on every operation. getclean logs it with the call, so a request in your traces can be matched to its Request-Id, and never forwards it to a site or a source, a stated departure from W3C Trace Context section 3.4, which asks a vendor to pass it on. A malformed value is ignored, never refused, as the same recommendation asks.

Query Parameters

state
string

Only jobs in this state; queued, running, completed, failed or canceled, the last three final; an open set. Default none.

Minimum string length: 1
Examples:

"completed"

"queued"

"running"

"failed"

"canceled"

kind
string

Only jobs of this kind, upload_contents, an open set. Default none.

Minimum string length: 1
Example:

"upload_contents"

page_size
integer
default:50

At most this many jobs on the page, from 1; default 50; the maximum, 200, stands in Limits.bounds, and a larger value is lowered with the notice page_size_lowered.

Required range: x >= 1
page_token
string

The next page, as the last answer's next_page_token gave it; opaque, at most 1,024 characters, never built by the caller. Default none, the first page.

Required string length: 1 - 1024

Response

One page of the account's jobs, newest first; next_page_token while more remain.

One page of the account's jobs, the answer of list_jobs, newest first.

jobs
object[]
required

The jobs of this page; [] when none matches.

notices
object[]
required

This call's notices, page_size_lowered; [] when there is none.

request_id
string
required

This call's id, the same as the Request-Id header.

Pattern: ^req_[A-Za-z0-9]{22}$
Example:

"req_01RcyYPWPnGlycDKoB9AfI"

next_page_token
string

The token for the next page; pass it as page_token. Present while more remains, and a page that carries it always has at least one job.

Maximum string length: 1024