Skip to main content
GET
/
sign_templates
/
{template_id}
cURL
curl -L -X GET "https://api.box.com/2.0/sign_templates/12345678" \
     -H "accept: application/json" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
{
  "type": "sign-template",
  "id": "4206996024-14944f75-c34b-478a-95a1-264b1ff80d35",
  "name": "Official contract",
  "email_subject": "Sign Request from Acme",
  "email_message": "Hello! Please sign the document below",
  "days_valid": 2,
  "parent_folder": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contracts"
  },
  "source_files": [
    {
      "id": "12345",
      "type": "file",
      "etag": "1",
      "sequence_id": "3",
      "name": "Contract.pdf",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
      "file_version": {
        "id": "12345",
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      }
    }
  ],
  "are_fields_locked": false,
  "are_options_locked": true,
  "are_recipients_locked": false,
  "are_email_settings_locked": true,
  "are_files_locked": true,
  "signers": [
    {
      "inputs": [
        {
          "page_index": 4,
          "document_tag_id": "1234",
          "text_value": "text",
          "checkbox_value": true,
          "date_value": "2021-04-26",
          "type": "text",
          "content_type": "text",
          "is_required": true,
          "document_id": "123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7",
          "dropdown_choices": [
            "Yes",
            "No",
            "Maybe"
          ],
          "group_id": "da317330-225a-4c72-89ad-0d6dcaaf4df6",
          "coordinates": {
            "x": 0.672258592471358,
            "y": 0.18654283173599448
          },
          "dimensions": {
            "width": 0.2618657937806874,
            "height": 0.05311728090109673
          },
          "label": "Legal name",
          "read_only": true,
          "validation": {
            "validation_type": "email"
          }
        }
      ],
      "email": "example@mail.com",
      "role": "signer",
      "is_in_person": true,
      "order": 2,
      "signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7",
      "label": "Jane Doe",
      "public_id": "RJZYYVPR",
      "is_password_required": true,
      "is_phone_number_required": true,
      "login_required": true
    }
  ],
  "additional_info": {
    "non_editable": [
      "email_subject",
      "name"
    ],
    "required": {
      "signers": [
        [
          "email"
        ],
        [
          "email"
        ]
      ]
    }
  },
  "ready_sign_link": {
    "url": "\"https://app.box.com/sign/\nready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178\"",
    "name": "Official contract",
    "instructions": "Hello! Please sign the document below",
    "folder_id": "12345",
    "is_notification_disabled": true,
    "is_active": false
  },
  "custom_branding": {
    "company_name": "Corporation inc.",
    "logo_uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA\nAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A\n8AAQUBAScY42YAAAAASUVORK5CYII=",
    "branding_color": "9E5E6F",
    "email_footer_text": "Contact email email@mail.com"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.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.

Path Parameters

​
template_id
string
required

The ID of a Box Sign template.

Response

Returns details of a template.

A Box Sign template object.

​
type
enum<string>

The value will always be sign-template.

Available options:
sign-template
Example:

"sign-template"

​
id
string

Template identifier.

Example:

"4206996024-14944f75-c34b-478a-95a1-264b1ff80d35"

​
name
string | null

The name of the template.

Example:

"Official contract"

​
email_subject
string | null

Subject of signature request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.

Example:

"Sign Request from Acme"

​
email_message
string | null

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.

Example:

"Hello! Please sign the document below"

​
days_valid
integer | null

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.

Required range: 0 <= x <= 730
Example:

2

​
parent_folder
Folder (Mini) · object

The destination folder to place final, signed document and signing log. Only ID and type fields are required. The root folder, folder ID 0, cannot be used.

​
source_files
File (Mini) · object[]

List of files to create a signing document from. Only the ID and type fields are required for each file.

​
are_fields_locked
boolean

Indicates if the template input fields are editable or not.

Example:

false

​
are_options_locked
boolean

Indicates if the template document options are editable or not, for example renaming the document.

Example:

true

​
are_recipients_locked
boolean

Indicates if the template signers are editable or not.

Example:

false

​
are_email_settings_locked
boolean

Indicates if the template email settings are editable or not.

Example:

true

​
are_files_locked
boolean

Indicates if the template files are editable or not. This includes deleting or renaming template files.

Example:

true

​
signers
Signer fields for Templates · object[]

Array of signers for the template.

Note: It may happen that some signers specified in the template belong to conflicting segments (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.

​
additional_info
object

Additional information on which fields are required and which fields are not editable.

​
ready_sign_link
object

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_branding
object

Custom branding applied to notifications and signature requests.