---
title: "Get render batch"
method: GET
path: "/v2/organizations/{organizationId}/batches/{batchId}"
tags: ["Render jobs"]
---

# Get render batch

`GET /v2/organizations/{organizationId}/batches/{batchId}`

## Request

- Base URL: `https://api.pdfs.build`
- URL: `https://api.pdfs.build/v2/organizations/{organizationId}/batches/{batchId}`
- Auth: HTTP bearer

## Response `200`

Batch progress and every item's status, in submission order.

- RenderBatch
  - `id` string, required
  - `status` 'processing' | 'completed', required
  - `templateExternalId` string, nullable, required
  - `total` integer, required
  - `succeeded` integer, required
  - `failed` integer, required
  - `pending` integer, required: Items still queued or processing.
  - `createdAt` string, required: UTC, ISO 8601 without a timezone suffix.
  - `completedAt` string: UTC, ISO 8601 without a timezone suffix.
  - `items` object[], required
    - `index` integer, required: Position in the submitted `items`.
    - `jobId` string, required: Also usable with the render job routes.
    - `status` 'queued' | 'processing' | 'success' | 'error', required
    - `downloadUrl` string, uri: Present once the item has succeeded. Requires the same API key.
    - `error` string: Present when `status` is `error`.

## Other responses

- `401`: Missing, invalid or expired API key.
- `403`: The organization in the URL does not match the API key's organization.
- `404`: Unknown batch.

---

[API](https://skmtc.dev/pdfs/apis/pdfs-build-api.md) · [All operations](https://skmtc.dev/pdfs/apis/pdfs-build-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pdfs/apis/pdfs-build-api/revisions/1c7340b9521d?raw)