---
title: "List defined batches"
method: GET
path: "/v2/batches"
tags: ["Batches"]
---

# List defined batches

`GET /v2/batches`

## 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`
- Auth: API key in header `X-API-KEY`

Lists the batches defined in AIVA.

## Query parameters

- `name` string
- `isEnabled` boolean
- `scheduleType` 'Manual' | 'Recurring'
- `page` integer
- `pageSize` integer

## Response `200`

Array of defined batches

- 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
- `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)