---
title: "Get Template"
method: GET
path: "/template/{template_id}"
tags: ["Template"]
---

# Get Template

`GET /template/{template_id}`

Returns the Template specified by the `template_id` parameter.

## Path parameters

- `template_id` string, required

## Response `200`

successful operation

- TemplateGetResponse
  - `template` TemplateResponse, required — Contains information about the templates you and your team have created.
    - `template_id` string — The id of the Template.
    - `title` string — The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.
    - `message` string — The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.
    - `updated_at` integer — Time the template was last updated.
    - `is_embedded` boolean, nullable — `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.
    - `is_creator` boolean — `true` if you are the owner of this template, `false` if it's been shared with you by a team member.
    - `can_edit` boolean — Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).
    - `is_locked` boolean — Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests.
    - `metadata` object — The metadata attached to the template.
    - `signer_roles` TemplateResponseSignerRole[] — An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
      - `name` string — The name of the Role.
      - `order` integer — If signer order is assigned this is the 0-based index for this role.
    - `cc_roles` TemplateResponseCCRole[] — An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.
      - `name` string — The name of the Role.
    - `documents` TemplateResponseDocument[] — An array describing each document associated with this Template. Includes form field data for each document.
      - `name` string — Name of the associated file.
      - `index` integer — Document ordering, the lowest index is displayed first and the highest last (0-based indexing).
      - `field_groups` TemplateResponseDocumentFieldGroup[] — An array of Form Field Group objects.
        - `name` string — The name of the form field group.
        - `rule` TemplateResponseDocumentFieldGroupRule — The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).
          - `requirement` string — Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group.
          - `groupLabel` string — Name of the group
      - `form_fields` TemplateResponseDocumentFormFieldBase[] — An array of Form Field objects containing the name and type of each named field.
        - `api_id` string — A unique id for the form field.
        - `name` string — The name of the form field.
        - `type` string, required
        - `signer` string — The signer of the Form Field.
        - `x` integer — The horizontal offset in pixels for this form field.
        - `y` integer — The vertical offset in pixels for this form field.
        - `width` integer — The width in pixels of this form field.
        - `height` integer — The height in pixels of this form field.
        - `required` boolean — Boolean showing whether or not this field is required.
      - `custom_fields` TemplateResponseDocumentCustomFieldBase[] — An array of Form Field objects containing the name and type of each named field.
        - `api_id` string — The unique ID for this field.
        - `name` string — The name of the Custom Field.
        - `type` string, required
        - `signer` string, nullable — The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).
        - `x` integer — The horizontal offset in pixels for this form field.
        - `y` integer — The vertical offset in pixels for this form field.
        - `width` integer — The width in pixels of this form field.
        - `height` integer — The height in pixels of this form field.
        - `required` boolean — Boolean showing whether or not this field is required.
        - `group` string, nullable — The name of the group this field is in. If this field is not a group, this defaults to `null`.
      - `static_fields` TemplateResponseDocumentStaticFieldBase[] — An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.
        - `api_id` string — A unique id for the static field.
        - `name` string — The name of the static field.
        - `type` string, required
        - `signer` string — The signer of the Static Field.
        - `x` integer — The horizontal offset in pixels for this static field.
        - `y` integer — The vertical offset in pixels for this static field.
        - `width` integer — The width in pixels of this static field.
        - `height` integer — The height in pixels of this static field.
        - `required` boolean — Boolean showing whether or not this field is required.
        - `group` string, nullable — The name of the group this field is in. If this field is not a group, this defaults to `null`.
    - `custom_fields` TemplateResponseDocumentCustomFieldBase[], nullable — Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.
      - `api_id` string — The unique ID for this field.
      - `name` string — The name of the Custom Field.
      - `type` string, required
      - `signer` string, nullable — The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).
      - `x` integer — The horizontal offset in pixels for this form field.
      - `y` integer — The vertical offset in pixels for this form field.
      - `width` integer — The width in pixels of this form field.
      - `height` integer — The height in pixels of this form field.
      - `required` boolean — Boolean showing whether or not this field is required.
      - `group` string, nullable — The name of the group this field is in. If this field is not a group, this defaults to `null`.
    - `named_form_fields` TemplateResponseDocumentFormFieldBase[], nullable — Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.
      - `api_id` string — A unique id for the form field.
      - `name` string — The name of the form field.
      - `type` string, required
      - `signer` string — The signer of the Form Field.
      - `x` integer — The horizontal offset in pixels for this form field.
      - `y` integer — The vertical offset in pixels for this form field.
      - `width` integer — The width in pixels of this form field.
      - `height` integer — The height in pixels of this form field.
      - `required` boolean — Boolean showing whether or not this field is required.
    - `accounts` TemplateResponseAccount[] — An array of the Accounts that can use this Template.
      - `account_id` string — The id of the Account.
      - `email_address` string — The email address associated with the Account.
      - `is_locked` boolean — Returns `true` if the user has been locked out of their account by a team admin.
      - `is_paid_hs` boolean — Returns `true` if the user has a paid Dropbox Sign account.
      - `is_paid_hf` boolean — Returns `true` if the user has a paid HelloFax account.
      - `quotas` TemplateResponseAccountQuota — An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.
        - `templates_left` integer — API templates remaining.
        - `api_signature_requests_left` integer — API signature requests remaining.
        - `documents_left` integer — Signature requests remaining.
        - `sms_verifications_left` integer — SMS verifications remaining.
    - `attachments` SignatureRequestResponseAttachment[] — Signer attachments.
      - `id` string, required — The unique ID for this attachment.
      - `signer` string, required — The Signer this attachment is assigned to.
      - `name` string, required — The name of this attachment.
      - `required` boolean, required — A boolean value denoting if this attachment is required.
      - `instructions` string, nullable — Instructions for Signer.
      - `uploaded_at` integer, nullable — Timestamp when attachment was uploaded by Signer.
  - `warnings` WarningResponse[] — A list of warnings.
    - `warning_msg` string, required — Warning message
    - `warning_name` string, required — Warning name

## Other responses

- `4XX` — failed_operation

---

[API](https://skmtc.net/hellosign/apis/dropbox-sign-api.md) · [All operations](https://skmtc.net/hellosign/apis/dropbox-sign-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hellosign/dropbox-sign-api/versions/2ea3f04008af/schema)