Box Developer Documentation
Log in

Box Doc Gen templates

Guides Box Doc Gen Box Doc Gen templates
Edit this page

Box Doc Gen templates

Box Doc Gen API allows you to retrieve information related to Box Doc Gen templates.

Prerequisites

Before you start using Box Doc Gen API, follow the steps listed in the get started with Box Doc Gen guide to create a custom app and a Box Doc Gen template.

List Box Doc Gen templates

To get a list of all created Box Doc Gen templates, use the GET /2.0/docgen_templates endpoint. You don't have to provide any additional parameters.

cURL
curl -L 'https://api.box.com/2.0/docgen_templates' \
     -H 'box-version: 2025.0' \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'

The response will contain an entries array listing the already created Box Doc Gen templates.

Get a Box Doc Gen template by ID

To get a specific Box Doc Gen template, use the GET /2.0/docgen_templates_id endpoint and provide the template_id.

cURL
curl -L 'https://api.box.com/2.0/docgen_templates/12345678' \
     -H 'box-version: 2025.0' \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'

The response will contain details of a file that was used as a Box Doc Gen template.

List all document generation jobs for a template

To get a list of all created Box Doc Gen templates, use the GET /2.0/docgen_template_jobs_id endpoint and provide the template_id.

cURL
curl -L 'https://api.box.com/2.0/docgen_template_jobs/12345678' \
     -H 'box-version: 2025.0' \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'

The response will contain a list of Box Doc Gen jobs that were run to generate documents.