Get Box Doc Gen template by ID

Lists details of a specific Box Doc Gen template.

GET /docgen_templates/{template_id}

cURL

cURL

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

client.docgen_template.get_docgen_template_by_id_v2025_r0(
    created_docgen_template.file.id
)

await client.docgenTemplate.getDocgenTemplateByIdV2025R0(
  createdDocgenTemplate.file!.id,
);

try await client.docgenTemplate.getDocgenTemplateByIdV2025R0(templateId: createdDocgenTemplate.file!.id)

client.getDocgenTemplate().getDocgenTemplateByIdV2025R0(createdDocgenTemplate.getFile().getId())

await client.DocgenTemplate.GetDocgenTemplateByIdV2025R0Async(templateId: NullableUtils.Unwrap(createdDocgenTemplate.File).Id);

200

{
  "file": {
    "type": "file",
    "id": "42037322"
  },
  "file_name": "Official contract"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

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

template_id · string · required

The ID of a Box Doc Gen template.

Response

200

application/json

Returns a template.

A Box Doc Gen template object.

file · File reference · object

Enable the file to generate a document from.

Show child attributes

file_name · string | null

The name of the template.

Example:

"Official contract"