START NOW
Jobs

Get All Jobs

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

GET/jobs

Authorizations

X-API-KEYstringheaderrequired

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

vendorenum<string>

Filter jobs by vendor

Available options: aws, azure, ibm, ionq, qbraid, all
providerstring

Filter jobs by provider name

statusGroupenum<string>

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

Available options: all, pending, returned
statusenum<string>

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

Available options: INITIALIZING, QUEUED, VALIDATING, RUNNING, CANCELLING, CANCELLED, COMPLETED, FAILED, UNKNOWN, HOLD
searchstring

Search jobs by keyword (1–255 characters)

tagsstring

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

pageintegerdefault: 1

Page number (1-indexed, default: 1)

limitintegerdefault: 50

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

Response

200Paginated jobs.
successbooleanrequired
dataobject[]required

Array of jobs matching the query filters

paginationobjectrequired
metaobjectrequired
List jobs
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.json())
const url = "https://api-v2.qbraid.com/api/v1/jobs";
const options = {
  method: "GET",
  headers: {"X-API-KEY":"<api-key>"},
};

const response = await fetch(url, options);
console.log(await response.json());
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-v2.qbraid.com/api/v1/jobs",
  CURLOPT_RETURNTRANSFER => true,
  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"
	"io"
	"net/http"
)

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, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))
}
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api-v2.qbraid.com/api/v1/jobs"))
    .header("X-API-KEY", "<api-key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
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
{
  "success": true,
  "data": [
    {
      "name": "<string>",
      "shots": 123,
      "deviceQrn": "<string>",
      "tags": {},
      "runtimeOptions": {},
      "jobQrn": "<string>",
      "batchJobQrn": "<string>",
      "vendor": "aws",
      "provider": "aqt",
      "status": "<string>",
      "statusMsg": "<string>",
      "experimentType": "<string>",
      "queuePosition": 123,
      "timeStamps": {
        "createdAt": "2024-01-01T00:00:00Z",
        "endedAt": "2024-01-01T00:00:00Z",
        "executionDuration": 123
      },
      "cost": 123,
      "estimatedCost": 123,
      "metadata": {}
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123,
    "hasNext": true,
    "hasPrev": true
  },
  "meta": {
    "timestamp": "2024-01-01T00:00:00Z"
  }
}