A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.
Latest version
Get Box Doc Gen template by ID
API version 2025.0
Lists details of a specific Box Doc Gen template.
Request
bearer [ACCESS_TOKEN]
application/json
Request Headers
stringin headerrequired
Version header.
Value is always 2025.0
Path Parameters
stringin pathrequired
123The ID of a Box Doc Gen template.
Response
application/jsonBox Doc Gen template
Returns a template.
application/jsonClient error
Returned when the access token provided in the Authorization header
is not recognized or not provided.
application/jsonClient error
Returned if the template is not found or the user does not have access to the associated template.
application/jsonClient error
An unexpected client error.
Request Example
cURL
curl -L 'https://api.box.com/2.0/docgen_templates/12345678' \
-H 'box-version: 2025.0' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'Node/TypeScript v10
await client.docgenTemplate.getDocgenTemplateByIdV2025R0(
createdDocgenTemplate.file!.id,
);Python v10
client.docgen_template.get_docgen_template_by_id_v2025_r0(
created_docgen_template.file.id
).NET v10
await client.DocgenTemplate.GetDocgenTemplateByIdV2025R0Async(templateId: NullableUtils.Unwrap(createdDocgenTemplate.File).Id);Swift v10
try await client.docgenTemplate.getDocgenTemplateByIdV2025R0(templateId: createdDocgenTemplate.file!.id)Java v10
client.getDocgenTemplate().getDocgenTemplateByIdV2025R0(createdDocgenTemplate.getFile().getId())Response Example
{
"file": {
"id": "42037322",
"type": "file"
},
"file_name": "Official contract"
}