Box Developer Documentation
Log in
Latest version

Get Box Sign template by ID

get
https://api.box.com/2.0
/sign_templates/:template_id

Fetches details of a specific Box Sign template.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
123075213-7d117509-8f05-42e4-a5ef-5190a319d41d

The ID of a Box Sign template.

Response

application/jsonBox Sign template

Returns details of 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.

get
Get Box Sign template by ID
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -L -X GET "https://api.box.com/2.0/sign_templates/12345678" \
     -H "accept: application/json" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
TypeScript Gen
await client.signTemplates.getSignTemplateById(signTemplates.entries![0].id!);
Python Gen
client.sign_templates.get_sign_template_by_id(sign_templates.entries[0].id)
.NET Gen
await client.SignTemplates.GetSignTemplateByIdAsync(templateId: NullableUtils.Unwrap(NullableUtils.Unwrap(signTemplates.Entries)[0].Id));
Swift Gen (Beta)
try await client.signTemplates.getSignTemplateById(templateId: signTemplates.entries![0].id!)
Java
BoxSignTemplate signTemplate = new BoxSignTemplate(api, id);
BoxSignTemplate.Info signTemplateInfo = signTemplate.getInfo();
.NET
BoxSignTemplate signTemplate = await client.SignTemplatesManager.GetSignTemplateByIdAsync("12345");
Node
const sr = await client.signTemplates.getById({
	template_id: 12345,
});
console.log(
	`Sign template id ${sr.id} contains ${sr.source_files.length} files`
);

Response Example

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