CLclavata
Get Jobs

List jobs

Changed on

Retrieves a list of jobs with optional filtering by time ranges and status. Incomplete jobs will only include basic information. Failed jobs omit Job.error here; fetch failure details with GetJob or GetJobLabels. Available to policy-first and label-first accounts; works on any job in the account, including jobs from POST /v1/labels/evaluate.

get/v1/jobs

Request

Query parameters

query.createdTimeRange.startstring date-time

The start of the time range

query.createdTimeRange.endstring date-time

The end of the time range

query.createdTimeRange.inclusiveboolean

Whether to treat the time range as inclusive or exclusive

query.updatedTimeRange.startstring date-time

The start of the time range

query.updatedTimeRange.endstring date-time

The end of the time range

query.updatedTimeRange.inclusiveboolean

Whether to treat the time range as inclusive or exclusive

query.completedTimeRange.startstring date-time

The start of the time range

query.completedTimeRange.endstring date-time

The end of the time range

query.completedTimeRange.inclusiveboolean

Whether to treat the time range as inclusive or exclusive

query.status'JOB_STATUS_UNSPECIFIED' | 'JOB_STATUS_PENDING' | 'JOB_STATUS_RUNNING' | 'JOB_STATUS_COMPLETED' | 'JOB_STATUS_FAILED' | 'JOB_STATUS_CANCELED'

The status of the job

query.policyIdstring

Policy ID that created the job

pageSizeinteger

The maximum number of jobs to return. Defaults to 10, capped at 1000.

pageTokenstring

A token identifying the page to return; for keyset pagination

Response

A successful response.

nextPageTokenstring

Changes

  • d7a854b0070fRevision changes
    • warning

      added the new JOB_ERROR_REASON_CONTENT_TOO_LARGE enum value to the /// response property for the response status

  • f293b5bf2c4fRevision changes
    • info

      added the optional property // to the response with the status