---
title: "List batch items"
method: GET
path: "/v1/batches/{batch_id}/items"
tags: ["Batches"]
---

# List batch items

`GET /v1/batches/{batch_id}/items`

## Request

- Base URL: `https://api-eu.dynamicdocumentapi.com`
- URL: `https://api-eu.dynamicdocumentapi.com/v1/batches/{batch_id}/items`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Items in `index` order; `?status=failed` lists what `retry-failed` renders again.

## Path parameters

- `batch_id` string, required

## Query parameters

- `cursor` string
- `limit` integer
- `status` 'canceled' | 'failed' | 'pending' | 'queued' | 'succeeded'

## Response `200`

- BatchItemList
  - `data` BatchItem[], required
    - `error` object, nullable: The render error; after a retry `previous_render_id` names the old one.
    - `filename` string, nullable
    - `index` integer, required: 0-based position in `items` (or CSV data row).
    - `reference` string, nullable
    - `render_id` string, nullable: Set once the item is released.
    - `status` 'pending' | 'queued' | 'succeeded' | 'failed' | 'canceled', required
  - `has_more` boolean, required
  - `next_cursor` string, nullable
  - `object` 'list', required

## Other responses

- `400`: Unknown `status`.
- `401`: Missing, invalid, expired or revoked credentials.
- `403`: Insufficient scope, IP not allowed, workspace suspended or scheduled for deletion, or email not verified.
- `404`: Batch not found.
- `429`: Rate limited (`Retry-After`).

---

[API](https://skmtc.dev/dynamicdocumentapi/apis/dynamic-document-api.md) · [All operations](https://skmtc.dev/dynamicdocumentapi/apis/dynamic-document-api/llms.txt) · [OpenAPI document](https://skmtc.dev/dynamicdocumentapi/apis/dynamic-document-api/revisions/0f14bc0000f4?raw)