Skip to main content
GET
/
docgen_batch_jobs
/
{batch_id}
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>"
{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "id": "12345",
      "type": "docgen_job",
      "batch": {
        "id": "12345",
        "type": "docgen_batch"
      },
      "template_file": {
        "type": "file",
        "id": "42037322"
      },
      "template_file_version": {
        "id": "12345",
        "type": "file_version"
      },
      "status": "completed",
      "output_type": "docx",
      "output_file": {
        "type": "file",
        "id": "42037322"
      },
      "output_file_version": {
        "id": "12345",
        "type": "file_version"
      }
    }
  ]
}
Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
box-version
enum<string>
required

Version header.

Available options:
2025.0

Path Parameters

​
batch_id
string
required

Box Doc Gen batch ID.

Query Parameters

​
marker
string

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.

​
limit
integer<int64>

The maximum number of items to return per page.

Required range: x <= 1000

Response

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

A list of Box Doc Gen jobs with a standard set of parameters.

​
limit
integer<int64>

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

Example:

1000

​
next_marker
string | null

The marker for the start of the next page of results.

Example:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"

​
prev_marker
string | null

The marker for the start of the previous page of results.

Example:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"

​
entries
Box Doc Gen job · object[]

List of jobs.