Batches

List batches

Newest first. Test keys see test batches only.

get/v1/batches

Request

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

Query parameters

cursorstring
limitinteger

1 to 100 (default 50).

referencestring
status'canceled' | 'completed' | 'failed' | 'processing' | 'queued'
template_idstring

Response

has_moreboolean required
next_cursorstring nullable
object'list' required

Example response

{
  "data": [
    {
      "error": {
        "code": "item_files_expired"
      },
      "files": [
        {
          "bytes": 1843200,
          "content_type": "application/zip",
          "file_id": "file_01J9ZM1X3F7R8K2C4V6B8N0P2R",
          "filename": "certificates.zip"
        }
      ],
      "id": "bat_01J9ZN4T6V8X0Z2B4D6F8H0K2M",
      "template_id": "tpl_01J9ZK3M7Q8V5W2X4Y6Z8A0B1C"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.