v1

latestOpenAPI 3.1.02026-08-04222461539.5 KB
jobs

List jobs

get/jobs

Query parameters

environmentIdstring

Environment ID

When provided, only jobs for the given environment will be returned

spaceIdstring

Space ID

When provided, only jobs for the given space will be returned

workbookIdstring

Workbook ID

When provided, only jobs for the given workbook will be returned

fileIdstring

File ID

When provided, only jobs for the given file will be returned

parentIdstring

Pipeline Job ID

When provided, only jobs that are parts of the given job will be returned

pageSizeinteger

Number of jobs to return in a page (default 20)

pageNumberinteger

Based on pageSize, which page of jobs to return

sortDirection'asc' | 'desc'

Sort direction - asc (ascending) or desc (descending)

Sort direction - asc (ascending) or desc (descending)

excludeChildJobsboolean

When true, only top-level jobs will be returned unless a parentId is specified

sourcestring

When provided, only jobs with the given source will be returned

Headers

Authorizationstring required

Bearer authentication

X-Disable-Hooks'true' required

Response

Response with status 200