Get Jobs

GET

/api/v2/jobs

curl --request GET \
  --url 'https://example.com/api/v2/jobs?order_by=created_at&order_by_direction=ASC&limit=100&offset=0' \
  --header 'Authorization: Bearer <token>'

Retrieve a paginated list of jobs.

Supports ordering, pagination, and filtering via query parameters.

Returns: A paginated list of jobs excluding the result payload. To download results for a specific job, request a pre-signed URL via GET /api/v1/jobs/{job_id}/results_link.

Authorizations

• HTTPBearer

Parameters

Query Parameters

order_by

Order By

string

default: created_at

order_by_direction

SortDirection

string

default: DESC

Allowed values: ASC DESC

limit

Limit

integer

default: 100 > 0 < 101

offset

Offset

integer

0

id

Any of:

Array<string>

Array<string>

null

null

Unique id for the job

id__starts_with

Any of:

string

string

null

null

First characters of the job id

batch_id

Any of:

Array<string>

Array<string>

null

null

Owner batch of the job

project_id

Any of:

Array<string>

Array<string>

null

null

Owner project of the job

user_id

Any of:

Array<string>

Array<string>

null

null

Owner user of the job

status

Any of:

Array<string>

Array<string>

Allowed values: PENDING RUNNING DONE ERROR CANCELED CANCELING

null

null

Job status type enum

min_runs

Any of:

integer

integer

null

null

Minimum number of times the pulser sequence is repeated

max_runs

Any of:

integer

integer

null

null

Maximum number of times the pulser sequence is repeated

errors

Any of:

boolean

boolean

null

null

Whether errors were returned when executing the job

origin

Any of:

Array<string>

Array<string>

Allowed values: CLIENT AZURE OVH UNKNOWN

null

null

Origin of the job

start_date

Any of:

string

string format: date-time

null

null

Time when the emulator or QPU indicated a job was started

end_date

Any of:

string

string format: date-time

null

null

Time when the emulator or QPU indicated a job finished, failed or was cancelled

Responses

200

Successful Response

Media typeapplication/json

HeaderPaginatedResponse[ProducedPartialJobResponseV2]

object

status

JSendStatus

string

default: success

Allowed values: success fail error

message

Message

string

default: OK.

code

Code

string

default: 200

data

required

Data

Array<object>

ProducedPartialJobResponseV2

Response to a request for a job.

This schema defines all the fields that can be publicly shared by the API and do not require significant computational resources. For example, 'logs_links', 'results link' or 'sequence'

object

id

required

Id

Unique identifier for the job.

string format: uuid

parent_id

required

Any of:

string

string format: uuid

null

null

status

required

JobStatus

Current job status.

string

Allowed values: PENDING RUNNING DONE ERROR CANCELED CANCELING

runs

required

Any of:

integer

integer

null

null

batch_id

required

Batch Id

ID of the batch this job belongs to.

string format: uuid

project_id

required

Project Id

ID of the project this job belongs to.

string format: uuid

created_at

required

Created At

Timestamp when the job was created.

string format: date-time

updated_at

required

Updated At

Timestamp of the last job update.

string format: date-time

start_timestamp

required

Any of:

string

string format: date-time

null

null

end_timestamp

required

Any of:

string

string format: date-time

null

null

variables

required

Any of:

object

object

key

additional properties

any

null

null

errors

required

Any of:

Array<string>

Array<string>

null

null

progress

required

Any of:

integer

integer

<= 100

null

null

creation_order

required

Creation Order

Position of this job in the creation order within its batch.

integer

slurm_job_id

required

Any of:

string

string

null

null

slurm_cluster_name

required

Any of:

string

string

null

null

pagination

required

JSendPagination

Pagination information

object

total

required

Total

integer

start

required

Start

integer

end

required

End

integer

Example

{
  "status": "success",
  "message": "OK.",
  "code": "200",
  "data": [
    {
      "batch_id": "00000000-0000-0000-0000-000000000002",
      "created_at": "2025-01-15T10:30:00Z",
      "creation_order": 1,
      "end_timestamp": "2025-01-15T10:35:00Z",
      "id": "00000000-0000-0000-0000-000000000003",
      "progress": 100,
      "project_id": "00000000-0000-0000-0000-000000000001",
      "runs": 100,
      "start_timestamp": "2025-01-15T10:31:00Z",
      "status": "DONE",
      "updated_at": "2025-01-15T10:35:00Z",
      "variables": {
        "omega": 5
      }
    }
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}