Skip to content
Pasqal Documentation

Get All Batches

GET
/api/v1/batches

Parameters

Query Parameters

order_by
Order By
string
default: created_at
order_by_direction
string
Allowed values: ASC DESC
limit
Limit
integer
default: 100 > 0 < 101
offset
Offset
integer
id
Id

Unique id for the batch

Array<string>
default:

Unique id for the batch

id__starts_with
Id Starts With

First characters of the batch id

string
""

First characters of the batch id

project_id
Project Id

Owner project of the batch

Array<string>
default:

Owner project of the batch

user_id
User Id

Owner user of the batch

Array<string>
default:

Owner user of the batch

device_type
Device Type

Device type enum

Array<string>
default:

Device type enum

status

Batch status type enum

Array<string>
default:
Allowed values: PENDING RUNNING DONE CANCELED TIMED_OUT ERROR PAUSED

Batch status type enum

complete
Complete

Flag indicating whether the batch is waiting for extra jobs to be pushed

boolean
""

Flag indicating whether the batch is waiting for extra jobs to be pushed

open
Open

Flag indicating whether the batch is waiting for extra jobs to be pushed

boolean
""

Flag indicating whether the batch is waiting for extra jobs to be pushed

min_jobs
Min Jobs

Minimum number of jobs in the batch

integer
""

Minimum number of jobs in the batch

max_jobs
Max Jobs

Maximum number of jobs in the batch

integer
""

Maximum number of jobs in the batch

start_date
Start Date

Time when the emulator or QPU indicated a batch was started

string format: date-time
""

Time when the emulator or QPU indicated a batch was started

end_date
End Date

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

string format: date-time
""

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

queue_priority

Priority of the batch in the queue.

Array<string>
default:
Allowed values: CRITICAL HIGH MEDIUM LOW FREE

Priority of the batch in the queue.

Responses

200

Successful Response

HeaderPaginatedResponse[ProducedBatchResponse]

A list of responses with pagination information.

For backwards compatibility, this also exposes pagination using the following header format:

Access-Control-Expose-Headers: Content-Range
Content-Range: $FIRST_ITEM_IN_BATCH-$LAST_ITEM_IN_BACH/$TOTAL_ITEMS_AVAILABLE
object
status
string
Allowed values: success fail error
message
Message
string
default: OK.
code
Code
string
default: 200
data
required
Data
Array<object>
ProducedBatchResponse

Response for a batch request which does not include its jobs data.

This schema defines all the fields that can be publicly shared by the API.

object
id
required
Id
string format: uuid
parent_id
Parent Id
string format: uuid
status
required
BatchStatus

An enumeration.

string
Allowed values: PENDING RUNNING DONE CANCELED TIMED_OUT ERROR PAUSED
complete
required
Complete
boolean
open
required
Open
boolean
priority
required
Priority
integer
device_type
required
Device Type
string
user_id
required
User Id
string
project_id
required
Project Id
string format: uuid
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
jobs_count
required
Jobs Count
integer
jobs_count_per_status
required
Jobs Count Per Status
object
tags
required
Tags
Array<string>
configuration
Configuration
object
webhook
Webhook
string
start_datetime
Start Datetime
string format: date-time
end_datetime
End Datetime
string format: date-time
queue_priority
required
QueuePriority

Values represent the queue a value will be written to, each priority represents the order of preference batches will be executed. Queue priority is processed in a descending order: CRITICAL, HIGH, MEDIUM, LOW, FREE

string
Allowed values: CRITICAL HIGH MEDIUM LOW FREE
pagination
required
JSendPagination

Pagination information

object
total
required
Total
integer
start
required
Start
integer
end
required
End
integer

422

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string