jobs

List review jobs

get/api/jobs

Query parameters

idinteger

Return a single job by ID

Return a single job by ID

statusstring

Filter by job status

Filter by job status

repostring[] nullable

Filter by repo root path (repeatable)

Filter by repo root path (repeatable)

git_refstring

Filter by git ref

Filter by git ref

branchstring

Filter by branch name

Filter by branch name

branch_empty'true' | 'false' | ''

Only jobs with empty or unset branch

Only jobs with empty or unset branch

branch_include_empty'true' | 'false' | ''

Include jobs with no branch when filtering by branch

Include jobs with no branch when filtering by branch

closed'true' | 'false' | ''

Filter by review closed state

Filter by review closed state

job_typestring

Filter by job type

Filter by job type

exclude_job_typestring

Exclude jobs of this type

Exclude jobs of this type

hide_classify_jobs'true' | 'false' | ''

Hide auto-design-router rows (job_type=classify and status=skipped)

Hide auto-design-router rows (job_type=classify and status=skipped)

panel_runstring

Return all jobs (members + synthesis) of one panel run

Return all jobs (members + synthesis) of one panel run

omit_prompt'true' | 'false' | ''

Omit prompt and diff content from returned jobs (metadata-only listing; queued/running jobs keep their prompt)

Omit prompt and diff content from returned jobs (metadata-only listing; queued/running jobs keep their prompt)

repo_prefixstring

Filter repos by path prefix

Filter repos by path prefix

limitinteger

Max results (default 50, 0=unlimited, max 10000)

Max results (default 50, 0=unlimited, max 10000)

offsetinteger

Skip N results (requires limit>0)

Skip N results (requires limit>0)

beforeinteger

Deprecated numeric job cursor retained for compatibility

Deprecated numeric job cursor retained for compatibility

cursorstring

Opaque next_cursor from a previous page; resumes after its immutable enqueue-time position

Opaque next_cursor from a previous page; resumes after its immutable enqueue-time position

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

has_moreboolean required
next_cursorstring nullable required

Opaque resume cursor when more jobs are available

Example response

{
  "$schema": "https://example.com/ListJobsOutputBody.json",
  "jobs": [
    {
      "$schema": "https://example.com/ReviewJob.json"
    }
  ]
}

Changes

Changed in 6 of the 23 revisions of this API.314

    • added the optional property jobs/items/experiments to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/resume_source_job_uuid to the response with the 200 status

      response-optional-property-added

    • added the new optional query request parameter branch_empty

      new-optional-request-parameter

    • added the new optional query request parameter cursor

      new-optional-request-parameter

    • added the optional property filtered_stats to the response with the 200 status

      response-optional-property-added

    • added the required property next_cursor to the response with the 200 status

      response-required-property-added

    • added the required property stats/canceled to the response with the 200 status

      response-required-property-added

    • added the required property stats/failed to the response with the 200 status

      response-required-property-added

    • added the required property stats/queued to the response with the 200 status

      response-required-property-added

    • added the required property stats/running to the response with the 200 status

      response-required-property-added

    • added the required property stats/skipped to the response with the 200 status

      response-required-property-added

    • added the new optional query request parameter omit_prompt

      new-optional-request-parameter

    • added the optional property jobs/items/panel_summary/first_started_at to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/panel_summary/members_with_cost to the response with the 200 status

      response-optional-property-added

    • deleted the query request parameter omit_prompt

      request-parameter-removed

    • removed the optional property jobs/items/panel_summary/first_started_at from the response with the 200 status

      response-optional-property-removed

    • removed the optional property jobs/items/panel_summary/members_with_cost from the response with the 200 status

      response-optional-property-removed

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog