Get All Batches
Retrieve a paginated list of all batches for the authenticated user.
Supports ordering, pagination, and filtering via query parameters.
Returns: A paginated collection of batches with job status counts.
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”Unique id for the batch
Unique id for the batch
First characters of the batch id
First characters of the batch id
Owner project of the batch
Owner project of the batch
Owner user of the batch
Owner user of the batch
Device type enum
Device type enum
Batch status type enum
Batch status type enum
Deprecated. Use open instead.
Deprecated. Use open instead.
Filter by whether the batch is still open.
Filter by whether the batch is still open.
Minimum number of jobs in the batch
Minimum number of jobs in the batch
Maximum number of jobs in the batch
Maximum number of jobs in the batch
Time when the emulator or QPU indicated a batch was started
Time when the emulator or QPU indicated a batch was started
Time when the emulator or QPU indicated a batch finished, failed or was cancelled
Time when the emulator or QPU indicated a batch finished, failed or was cancelled
Priority of the batch in the queue.
Priority of the batch in the queue.
Tag used to identify the batch
Tag used to identify the batch
Responses
Section titled “ Responses ”Successful Response
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_AVAILABLEobject
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
Unique identifier for the batch.
ID of the parent batch if created from a retry.
Current batch status.
Deprecated. Use open instead. Indicates whether the batch is still accepting additional jobs. False means the batch is open; True means it is closed.
Whether the batch is open and accepting additional jobs.
Deprecated. Priority of the batch.
Target device type for the batch.
ID of the user who created the batch.
ID of the project this batch belongs to.
Timestamp when the batch was created.
Timestamp of the last batch update.
Total number of jobs in the batch.
Number of jobs grouped by status.
object
User-defined labels for organizing batches.
Deprecated. Use backend_configuration. Extra configuration for job execution.
object
Serialized emulator backend configuration.
URL where job results are sent via webhook.
Timestamp when processing started on hardware.
Timestamp when processing finished, errored, or was canceled.
Priority queue on which the batch is scheduled.
Example
{ "id": "00000000-0000-0000-0000-000000000002", "status": "DONE", "complete": true, "open": false, "priority": 0, "device_type": "FRESNEL", "user_id": "user-123", "project_id": "00000000-0000-0000-0000-000000000001", "created_at": "2025-01-15T10:30:00Z", "updated_at": "2025-01-15T10:35:00Z", "jobs_count": 3, "jobs_count_per_status": { "DONE": 3 }, "tags": [ "experiment-1" ], "start_datetime": "2025-01-15T10:31:00Z", "end_datetime": "2025-01-15T10:35:00Z", "queue_priority": "MEDIUM"}Pagination information
object
Validation Error