Sample - Box Platform API
GET/sign_templates/{template_id}

Get a Box Sign template

Retrieves a specific Box Sign template by its identifier. Supply template_id to retrieve the template details, including its files, signers, email settings, and lock settings.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter
template_idstringrequired
The unique identifier of the Box Sign template to retrieve.

4 status codes
200Returns the Box Sign template object, including its identifier, name, source files, signers, email settings, and configuration locks.
typestringoptional
The value will always be `sign-template`.
Allowed:sign-template
idstringoptional
Template identifier.
namestringoptional
The name of the template.
email_subjectstringoptional
Subject of signature request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.
email_messagestringoptional
Message to include in signature request email. The field is cleaned through sanitization of specific characters. However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. The message may contain the following html tags including `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong`. Be aware that when the text to html ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.
days_validintegeroptional
Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire.
parent_folderobjectoptional
source_filesarray<FileMini>optional
List of files to create a signing document from. Only the ID and type fields are required for each file.
are_fields_lockedbooleanoptional
Indicates if the template input fields are editable or not.
are_options_lockedbooleanoptional
Indicates if the template document options are editable or not, for example renaming the document.
are_recipients_lockedbooleanoptional
Indicates if the template signers are editable or not.
are_email_settings_lockedbooleanoptional
Indicates if the template email settings are editable or not.
are_files_lockedbooleanoptional
Indicates if the template files are editable or not. This includes deleting or renaming template files.
signersarray<SignerFieldsForTemplates>optional
Array of signers for the template. **Note**: It may happen that some signers specified in the template belong to conflicting [segments](https://developer.box.com/reference/resources/shield-information-barrier-segment-member) (user groups). This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts. In such a case, an attempt to send a sign request based on a template that lists signers in conflicting segments will result in an error. Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ).
additional_infoobjectoptional
Additional information on which fields are required and which fields are not editable.
ready_sign_linkobjectoptional
Box's ready-sign link feature enables you to create a link to a signature request that you've created from a template. Use this link when you want to post a signature request on a public form — such as an email, social media post, or web page — without knowing who the signers will be. Note: The ready-sign link feature is limited to Enterprise Plus customers and not available to Box Verified Enterprises.
custom_brandingobjectoptional
Custom branding applied to notifications and signature requests.
request_flowstringoptional
The sign flow of sign requests created from the template. Values can include `standard` or `cfr11`.
401Returned when the access token in the `Authorization` header is missing or not recognized.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
404Returned when the template is not found or the authenticated user does not have access to it.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
defaultReturned for an unexpected client error and includes a generic error object with a message and request identifier.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

A 401 is returned when the access token in the Authorization header is missing or not recognized. A 404 is returned when template_id does not identify a template that the authenticated user can access.