v106

OpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-03812347972.4 KB
job

get the ids of all jobs matching the given filters

get/w/{workspace}/jobs/list_filtered_uuids

Path parameters

workspacestring required

Query parameters

created_bystring

filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')

labelstring

filter by exact matching job label. Supports comma-separated list (e.g. 'deploy,release') and negation by prefixing all values with '!' (e.g. '!deploy,!release')

workerstring

filter by worker this job ran on. Supports comma-separated list (e.g. 'worker-1,worker-2') and negation by prefixing all values with '!' (e.g. '!worker-1,!worker-2')

parent_jobstring uuid

The parent job that is at the origin and responsible for the execution of this script if any

script_path_exactstring

filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2')

script_path_startstring

filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2')

schedule_pathstring

mask to filter by schedule path

script_hashstring

mask to filter exact matching path

started_beforestring date-time

filter on started before (inclusive) timestamp

started_afterstring date-time

filter on started after (exclusive) timestamp

created_beforestring date-time

filter on created before (inclusive) timestamp

created_afterstring date-time

filter on created after (exclusive) timestamp

completed_beforestring date-time

filter on started before (inclusive) timestamp

completed_afterstring date-time

filter on started after (exclusive) timestamp

created_before_queuestring date-time

filter on jobs created before X for jobs in the queue only

created_after_queuestring date-time

filter on jobs created after X for jobs in the queue only

runningboolean

filter on running jobs

scheduled_for_before_nowboolean

filter on jobs scheduled_for before now (hence waitinf for a worker)

job_kindsstring

filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies')

suspendedboolean

filter on suspended jobs

argsstring

filter on jobs containing those args as a json subset (@> in postgres)

tagstring

filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem')

resultstring

filter on jobs containing those result as a json subset (@> in postgres)

pageinteger

which page to return (start at 1, default 1)

per_pageinteger

number of items to return for a given page (default 30, max 100)

is_skippedboolean

is the job skipped

resolvedboolean

filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them

is_flow_stepboolean

is the job a flow step

has_null_parentboolean

has null parent

successboolean

filter on successful jobs

status'success' | 'failure' | 'canceled' | 'skipped'

filter on the exact completed job status. Unlike success=true (which also matches skipped), status=success matches only success.

all_workspacesboolean

get jobs from all workspaces (only valid if request come from the admins workspace)

is_not_scheduleboolean

is not a scheduled job

Response

uuids of jobs

string[] required