---
title: "Get a defined batch"
method: GET
path: "/v2/batches/{batchId}"
tags: ["Batches"]
---

# Get a defined batch

`GET /v2/batches/{batchId}`

## Request

- Base URL: `https://app.aiva.works` (the document declares no server; this is the origin it was published from)
- URL: `https://app.aiva.works/v2/batches/{batchId}`
- Auth: API key in header `X-API-KEY`

Returns one defined batch.

## Path parameters

- `batchId` string, guid, required

## Response `200`

The defined batch

- Batch
  - `id` string, guid, required
  - `name` string, required
  - `labels` string[]
  - `scheduleType` 'Manual' | 'Recurring'
  - `isEnabled` boolean
  - `createdAt` string, date-time

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: User does not have permission to access batches
- `404`: Batch with given ID not found
- `500`: Server Error

---

[API](https://skmtc.dev/aiva/apis/aiva-cloud-api.md) · [All operations](https://skmtc.dev/aiva/apis/aiva-cloud-api/llms.txt) · [OpenAPI document](https://skmtc.dev/aiva/apis/aiva-cloud-api/revisions/70eef14d3bcd?raw)