---
title: "List batches"
method: GET
path: "/batches"
---

# List batches

`GET /batches`

## Query parameters

- `page` integer

## Response `200`

Paginated list of batches

- object[]
  - `uid` string
  - `type` 'images'
  - `status` 'pending' | 'completed'
  - `total` integer
  - `counts` object
    - `completed` integer
    - `failed` integer
    - `invalid` integer
    - `pending` integer
  - `errors` object[]
  - `items` object[]
    - `uid` string
    - `status` 'pending' | 'completed' | 'failed'
    - `template` string
    - `files` object — Output file URLs keyed by format
    - `metadata` string, nullable
    - `error` string, nullable — Error message (only present on failure)
    - `self` string, uri
    - `created_at` string, date-time
    - `completed_at` string, date-time, nullable
  - `self` string, uri
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable

---

[API](https://skmtc.dev/bannerbear/apis/bannerbear-v5-api.md) · [All operations](https://skmtc.dev/bannerbear/apis/bannerbear-v5-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bannerbear/bannerbear-v5-api/revisions/6aa425420a10/schema)