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

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

idstring required
status'processing' | 'completed' required
templateExternalIdstring nullable required
totalinteger required
succeededinteger required
failedinteger required
pendinginteger required

Items still queued or processing.

createdAtstring required

UTC, ISO 8601 without a timezone suffix.

completedAtstring

UTC, ISO 8601 without a timezone suffix.

Example response

{
  "createdAt": "2026-08-30T12:00:00.123456",
  "completedAt": "2026-08-30T12:00:00.123456"
}

Changes

No recorded changes to this operation across all 1 revision of this API.