Skip to main content
GET
Get jobs

Authorizations

Authorization
string
header
required

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

Query Parameters

data_plane_id
string<uuid>

Filter jobs by data plane ID.

dataset_id
integer

Filter jobs where the input has a dataset_id (such as materalized-view)

offset
integer

Number of records to skip (page_number * per_page).

order_by
enum<string>

Order the results by a specific field. By default, job are order by created_at in descending order.

Available options:
created_at_asc,
created_at_desc,
updated_at_asc,
updated_at_desc
per_page
integer

Number of records to return. Defaults to 500, which is also the maximum; larger values are rejected with a 400.

Required range: x <= 500
state
enum<string>[]

Filter jobs by state. Repeat the parameter to match any of several states.

Available options:
cancelled,
completed,
failed,
pending,
pending_cancellation,
running,
scheduled
tag
string[]

Filter jobs by tag. Repeat the parameter to filter by multiple tags (e.g. ?tag=workflow_enqueued&tag=workflow_id=<uuid>); a job matches if it carries any of the supplied tags.

Required string length: 1 - 255
type
string[]

Filter jobs by type. Repeat the parameter to match any of several types. Job types are free strings on the server; see JobResponse for the ones this spec describes.

Required string length: 1 - 255
workflow_id
string<uuid>

Filter jobs by the id of the workflow that enqueued them. Only jobs enqueued by a workflow carry a workflow id.

workflow_run_id
string<uuid>

Filter jobs by the id of the workflow run that enqueued them. Only jobs enqueued by a workflow run carry a workflow run id.

Response

OK

A paginated list of jobs.

records
object[]
required

A job. Every job carries the same envelope of fields — see JobBase — but input and result hold job-type-specific payloads, so the response is a union over type: pick the branch whose type matches and you get the typed input and result for that kind of job.

The union is open on purpose. Job types are free strings on the server, so a type this spec version does not describe lands in OtherJobResponse, where both fields stay free-form. No branch closes itself to extra properties, and new job types can appear without a spec change.

input and result are returned exactly as they were stored when the job was enqueued or completed. The server never reshapes them, so a field a job type gained after a row was written is absent from that row rather than null. The typed branches describe what the current code writes; fields that have not always been written are left out of each branch's required list.

result is null in every branch until the job reaches a terminal state.

Example:
current_page
integer<int64>
required

The number of requested page.

Example:

1

total_records
integer<int64>
required

Total amount of accessible Access Rules

Example:

15000

total_pages
integer<int64>
required

Total amount of pages.

Example:

10

prev_page
integer<int64> | null

The number of the previous page, or null on the first page. Can also refer to the latest existing page if a page beyond the last one was requested.

Example:

1

next_page
integer<int64> | null

The number of the next page, or null on the last page.

Example:

42