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.

type
string[]

Filter jobs by type. Repeat the parameter to match any of several types.

Response

200 - application/json

OK

A paginated list of jobs.

records
object[]
required
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>

The number of previous page (if exists). Also can refer to the latest existing page if non-existing page was requested.

Example:

1

next_page
integer<int64>

The number of next page (if exists).

Example:

42