Jobs

List the caller's jobs with filtering, sorting, and pagination. Soft-deleted jobs are excluded.

get/jobs

Request

  • Base URL
    https://api-v2.qbraid.com/api/v1
  • URL
    https://api-v2.qbraid.com/api/v1/jobs
  • Auth
    API key in header X-API-KEY

Query parameters

vendor'aws' | 'azure' | 'ibm' | 'ionq' | 'qbraid' | 'all'

Filter jobs by vendor

providerstring

Filter jobs by provider name

statusGroup'all' | 'pending' | 'returned'

Filter by status group

Filter by status group — pending (active/in-progress), returned (completed/failed/cancelled), or all

status'INITIALIZING' | 'QUEUED' | 'VALIDATING' | 'RUNNING' | 'CANCELLING' | 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'UNKNOWN' | 'HOLD'

Filter by individual job status

Filter by individual job status. Takes priority over statusGroup when both are provided

searchstring

Search keyword

Search jobs by keyword (1–255 characters)

tagsstring

JSON object of tag key-value pairs to filter by

Example:{"experiment":"bell-state"}

Filter by tags as a JSON object (e.g., {"experiment":"bell-state"})

pageinteger

Page number (1-indexed)

Page number (1-indexed, default: 1)

limitinteger

Number of items per page

Number of items per page (1–100, default: 50)

Response

Paginated jobs.

successboolean required

Changes

    • info

      api operation id list_jobs_jobs_get removed and replaced with listJobs

    • info

      api tag Jobs added

    • info

      api tag jobs removed

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status