TItiliter
jobs

List jobs

Changed on

List jobs visible to the caller, newest first.

Cursor-paginated. Optionally filter by lifecycle status, by workflow_id (matches all jobs for that workflow), and/or by a search term.

search looks inside the job rather than at its name alone: an operator who recorded a tenant on a Selection step, or scanned an asset tag on a barcode step, can find those jobs afterwards (VA-694). See job_search_predicate for what it matches.

Visibility is role-scoped within the active organization: ADMIN and OWNER see every job in the org; VIEWER and MEMBER see only their own. Search narrows that scope; it never widens it.

get/api/v2/jobs

Request

Query parameters

cursorstring nullable
limitinteger nullable
status'in_progress' | 'analysing' | 'completed' | 'completed_with_errors' | 'abandoned'

Filter to jobs in this status.

workflow_idstring nullable

Filter to jobs of this workflow family.

searchstring nullable

Filter to jobs matching this text, case-insensitively. Matches Selection answers and barcode values recorded against the job, its step names, the workflow name, and the operator's name (or email when no name is set). Blank or whitespace-only is ignored.

Response

Successful Response

next_cursorstring nullable

Opaque cursor to fetch the next page. Null when this is the last page.

limitinteger required

Page size that was applied.

Example response

{
  "limit": 50
}

Changes

  • b29acb7cf93eRevision changes
    • info

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

  • eb7293c7622bRevision changes
    • info

      added the new optional query request parameter search

    • info

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

    • info

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

    • info

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