---
title: "Get a batch"
method: GET
path: "/api/v1alpha/batches/{batch_id}"
tags: ["Batches API v1Alpha"]
---

# Get a batch

`GET /api/v1alpha/batches/{batch_id}`

Get a batch by ID.

## Path parameters

- `batch_id` number, required

## Response `200`

Successfully retrieved the batch.

- BatchResponse
  - `id` integer — The batch ID
  - `user` string — The user who created the batch
  - `billing_project` string — The billing project associated with the batch
  - `token` string — Token for batch identification
  - `state` 'open' | 'complete' | 'cancelled' | 'failure' | 'running' — Current state of the batch
  - `complete` boolean — Whether the batch is complete
  - `closed` boolean — Whether the batch is closed
  - `n_jobs` integer — Total number of jobs in the batch
  - `n_completed` integer — Number of completed jobs
  - `n_succeeded` integer — Number of succeeded jobs
  - `n_failed` integer — Number of failed jobs
  - `n_cancelled` integer — Number of cancelled jobs
  - `time_created` string, date-time — When the batch was created
  - `time_completed` string, date-time, nullable — When the batch completed
  - `attributes` object — Key-value pairs of attributes for the batch

## Changes

- **2025-04-16** `afa3b61d1d09` — 15 info
  - added the optional property `attributes` to the response with the `200` status
  - added the optional property `billing_project` to the response with the `200` status
  - added the optional property `closed` to the response with the `200` status
  - added the optional property `complete` to the response with the `200` status
  - …11 more
- **2025-01-14** `559a91071cc1` — 15 warning
  - removed the optional property `attributes` from the response with the `200` status
  - removed the optional property `billing_project` from the response with the `200` status
  - removed the optional property `closed` from the response with the `200` status
  - removed the optional property `complete` from the response with the `200` status
  - …11 more

[Change history](https://skmtc.dev/hail-is/apis/hail-services/changes/api/v1alpha/batches/:batch_id/get.md)

---

[API](https://skmtc.dev/hail-is/apis/hail-services.md) · [All operations](https://skmtc.dev/hail-is/apis/hail-services/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hail-is/hail-services/revisions/3bd6e13adfa6/schema)