jobs

List review jobs

Changed on
get/api/jobs

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

idinteger

Return a single job by ID

statusstring

Filter by job status

repostring[]

Filter by repo root path (repeatable)

git_refstring

Filter by git ref

analysis_typestring

Filter by recorded analysis type

analysis_filestring[]

Filter by recorded analysis file (repeatable)

branchstring

Filter by branch name

branch_empty'true' | 'false' | ''

Only jobs with empty or unset branch

branch_include_empty'true' | 'false' | ''

Include jobs with no branch when filtering by branch

closed'true' | 'false' | ''

Filter by review closed state

job_typestring

Filter by job type

exclude_job_typestring

Exclude jobs of this type

hide_classify_jobs'true' | 'false' | ''

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

panel_runstring

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

include_panel_members'true' | 'false' | ''

Include individual panel member jobs alongside panel synthesis jobs

omit_prompt'true' | 'false' | ''

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

include_findings'true' | 'false' | ''

Include nullable finding severity counts for eligible completed reviews

repo_prefixstring

Filter repos by path prefix

limitinteger

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

offsetinteger

Skip N results (requires limit>0)

beforeinteger

Deprecated numeric job cursor retained for compatibility

cursorstring

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