Box Developer Documentation
Log in
Latest version

Get Box Doc Gen jobs by batch ID

get
https://api.box.com/2.0
/docgen_batch_jobs/:batch_id

Lists Box Doc Gen jobs in a batch.

Related Guides

Request

bearer [ACCESS_TOKEN]
application/json

Request Headers

stringin headerrequired

Version header.

Value is always 2025.0

Path Parameters

stringin pathrequired
123

Box Doc Gen batch ID.

Query Parameters

integer (int64)in queryoptional
1000
1000

The maximum number of items to return per page.

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

Response

application/jsonBox Doc Gen jobs

Returns a list of Box Doc Gen jobs in a Box Doc Gen batch.

application/jsonClient error

Returned if the user has passed in a malformed marker or limit value.

application/jsonClient error

The client does not have access rights to the content or resource requested.

application/jsonClient error

Returned if the batch is not found or the user does not have access to the associated batch.

application/jsonClient error

The user has sent too many requests in a given amount of time.

application/jsonClient error

An unexpected condition was encountered on the server.

get
Get Box Doc Gen jobs by batch ID
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


cURL
curl -i -X GET "https://api.box.com/2.0/docgen_batch_jobs/12345" \
     -H 'box-version: 2025.0' \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.docgen.getDocgenBatchJobByIdV2025R0(docgenBatch.id);
Python v10
client.docgen.get_docgen_batch_job_by_id_v2025_r0(docgen_batch.id)
.NET v10
await client.Docgen.GetDocgenBatchJobByIdV2025R0Async(batchId: docgenBatch.Id);
Swift v10
try await client.docgen.getDocgenBatchJobByIdV2025R0(batchId: docgenBatch.id)
Java v10
client.getDocgen().getDocgenBatchJobByIdV2025R0(docgenBatch.getId())

Response Example

{
  "entries": [
    {
      "id": "12345",
      "type": "docgen_job",
      "batch": {
        "id": "12345",
        "type": "docgen_batch"
      },
      "output_file": {
        "id": "42037322",
        "type": "file"
      },
      "output_file_version": {
        "id": "12345",
        "type": "file_version"
      },
      "output_type": "docx",
      "status": "completed",
      "template_file": {
        "id": "42037322",
        "type": "file"
      },
      "template_file_version": {
        "id": "12345",
        "type": "file_version"
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}