Skip to main content
GET
/
jobs
Get All Jobs
curl --request GET \
  --url https://api-v2.qbraid.com/api/v1/jobs \
  --header 'X-API-KEY: <api-key>'
{
  "success": true,
  "data": [
    {
      "name": "Bell state job",
      "shots": 1000,
      "deviceQrn": "qbraid:qbraid:sim:qir-sv",
      "tags": { "experiment": "bell-state" },
      "runtimeOptions": {},
      "jobQrn": "qbraid:job:abc123xyz",
      "batchJobQrn": null,
      "vendor": "qbraid",
      "provider": "qbraid",
      "status": "COMPLETED",
      "statusMsg": null,
      "experimentType": "gate_model",
      "queuePosition": null,
      "timeStamps": {
        "createdAt": "2025-01-15T10:30:00Z",
        "endedAt": "2025-01-15T10:30:05Z",
        "executionDuration": 5000
      },
      "cost": 0.501875,
      "estimatedCost": 0.5,
      "metadata": {}
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:06.000Z"
  }
}

{
  "success": true,
  "data": [
    {
      "name": "Bell state job",
      "shots": 1000,
      "deviceQrn": "qbraid:qbraid:sim:qir-sv",
      "tags": { "experiment": "bell-state" },
      "runtimeOptions": {},
      "jobQrn": "qbraid:job:abc123xyz",
      "batchJobQrn": null,
      "vendor": "qbraid",
      "provider": "qbraid",
      "status": "COMPLETED",
      "statusMsg": null,
      "experimentType": "gate_model",
      "queuePosition": null,
      "timeStamps": {
        "createdAt": "2025-01-15T10:30:00Z",
        "endedAt": "2025-01-15T10:30:05Z",
        "executionDuration": 5000
      },
      "cost": 0.501875,
      "estimatedCost": 0.5,
      "metadata": {}
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:06.000Z"
  }
}

Authorizations

​
X-API-KEY
string
header
required

Authenticate requests using an API key linked to your qBraid account. Obtain your key by registering or logging in at account-v2.qbraid.com.

Query Parameters

​
vendor
enum<string>

Filter jobs by vendor

Available options:
aws,
azure,
ibm,
ionq,
qbraid,
all
​
provider
string

Filter jobs by provider name

​
statusGroup
enum<string>

Filter by status group

Available options:
all,
pending,
returned
​
status
enum<string>

Filter by individual job status

Available options:
INITIALIZING,
QUEUED,
VALIDATING,
RUNNING,
CANCELLING,
CANCELLED,
COMPLETED,
FAILED,
UNKNOWN,
HOLD
​
search
string

Search jobs by keyword (1–255 characters) Search keyword

Required string length: 1 - 255
​
tags
string

Filter by tags as a JSON object (e.g., {"experiment":"bell-state"}) JSON object of tag key-value pairs to filter by

Example:

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

​
page
integer
default:1

Page number (1-indexed, default: 1) Page number (1-indexed)

Required range: x >= 1
​
limit
integer
default:50

Number of items per page

Required range: 1 <= x <= 100

Response

Successful Response

Paginated response for listing user jobs

​
success
boolean
required
​
data
RuntimeJob · object[]
required

Array of jobs matching the query filters

​
pagination
object
required
​
meta
object
required