Box Developer Documentation
Log in
Latest version

List all Box Doc Gen template tags in template

get
https://api.box.com/2.0
/docgen_templates/:template_id/tags

Lists all tags in a Box Doc Gen template.

Related Guides

Request

bearer [ACCESS_TOKEN]
application/json

Request Headers

stringin headerrequired

Version header.

Value is always 2025.0

Path Parameters

stringin pathrequired
123

ID of template.

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.

stringin queryoptional
123

Id of template version.

Response

application/jsonBox Doc Gen tags

A list of document generation template tags.

application/jsonBox Doc Gen tags processing message

Processing tags for the file.

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

The requested resource could not be found but may be available in the future.

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
List all Box Doc Gen template tags in template
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 -L 'https://api.box.com/2.0/docgen_templates/12345678/tags' \
     -H 'box-version: 2025.0' \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'
Node/TypeScript v10
await client.docgenTemplate.getDocgenTemplateTagsV2025R0(
  fetchedDocgenTemplate.file!.id,
);
Python v10
client.docgen_template.get_docgen_template_tags_v2025_r0(
    fetched_docgen_template.file.id
)
.NET v10
await client.DocgenTemplate.GetDocgenTemplateTagsV2025R0Async(templateId: NullableUtils.Unwrap(fetchedDocgenTemplate.File).Id);
Swift v10
try await client.docgenTemplate.getDocgenTemplateTagsV2025R0(templateId: fetchedDocgenTemplate.file!.id)
Java v10
client.getDocgenTemplate().getDocgenTemplateTagsV2025R0(fetchedDocgenTemplate.getFile().getId())

Response Example

{
  "entries": [
    {
      "json_paths": [
        "products",
        "products.name"
      ],
      "tag_content": "{{item.name}}",
      "tag_type": "text"
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}