Get All Jobs

Retrieve a paginated list of quantum jobs for the authenticated user.

Query Parameters:

• vendor (string, optional): Filter by vendor (e.g., aws, ibm, qbraid, or all)
• provider (string, optional): Filter by provider name
• statusGroup (string, optional): Filter by status group — pending, returned, or all
• status (string, optional): Filter by individual job status (takes priority over statusGroup)
• search (string, optional): Search jobs by keyword (1–255 characters)
• tags (string, optional): Filter by tags as a JSON object (e.g., {"env":"prod"})
• page (integer, optional): Page number (default: 1)
• limit (integer, optional): Items per page, max 100 (default: 50)

Returns:

• Paginated array of RuntimeJob objects with pagination metadata

Raises:

• 401: Authentication required
• 422: Validation error if query parameters are invalid

GET /jobs

Get All Jobs

cURL

curl --request GET \
  --url https://api-v2.qbraid.com/api/v1/jobs \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://api-v2.qbraid.com/api/v1/jobs"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api-v2.qbraid.com/api/v1/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-v2.qbraid.com/api/v1/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-v2.qbraid.com/api/v1/jobs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-v2.qbraid.com/api/v1/jobs")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-v2.qbraid.com/api/v1/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "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"
  }
}

200

{
  "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.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

200

application/json

Successful Response

Paginated response for listing user jobs

success · boolean · required

data · RuntimeJob · object[] · required

Array of jobs matching the query filters

Show child attributes

pagination · object · required

Show child attributes

meta · object · required

Show child attributes