--- title: "List Box Sign templates" method: GET path: "/sign_templates" tags: ["Box Sign templates"] --- # List Box Sign templates `GET /sign_templates` Gets Box Sign templates created by a user. ## Query parameters - `marker` string - `limit` integer ## Response `200` Returns a collection of templates. - SignTemplates — The part of an API response that describes marker based pagination. - `limit` integer — The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API. - `next_marker` string, nullable — The marker for the start of the next page of results. - `prev_marker` string, nullable — The marker for the start of the previous page of results. - `entries` SignTemplate[] — A list of templates. - `type` 'sign-template' — The value will always be `sign-template`. - `id` string — Template identifier. - `name` string, nullable — The name of the template. - `email_subject` string, nullable — Subject of signature request email. This is cleaned by sign request. If this field is not passed, a default subject will be used. - `email_message` string, nullable — 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_valid` integer, nullable — 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_folder` 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. - `id` string, required — The unique identifier that represent a folder. The ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folders/123` the `folder_id` is `123`. - `etag` string, nullable — The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened. - `type` 'folder', required — The value will always be `folder`. - `sequence_id` string — A numeric identifier that represents the most recent user event that has been applied to this item. This can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read. An example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource. - `name` string — The name of the folder. - `source_files` FileMini[] — List of files to create a signing document from. Only the ID and type fields are required for each file. - `id` string, required — The unique identifier that represent a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. - `etag` string, nullable — The HTTP `etag` of this file. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the file if (no) changes have happened. - `type` 'file', required — The value will always be `file`. - `sequence_id` string — A numeric identifier that represents the most recent user event that has been applied to this item. This can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read. An example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource. - `name` string — The name of the file. - `sha1` string, digest — The SHA1 hash of the file. This can be used to compare the contents of a file on Box with a local file. - `file_version` object — The information about the current version of the file. - `id` string, required — The unique identifier that represent a file version. - `type` 'file_version', required — The value will always be `file_version`. - `sha1` string — The SHA1 hash of this version of the file. - `are_fields_locked` boolean — Indicates if the template input fields are editable or not. - `are_options_locked` boolean — Indicates if the template document options are editable or not, for example renaming the document. - `are_recipients_locked` boolean — Indicates if the template signers are editable or not. - `are_email_settings_locked` boolean — Indicates if the template email settings are editable or not. - `are_files_locked` boolean — Indicates if the template files are editable or not. This includes deleting or renaming template files. - `signers` TemplateSigner[] — 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). - `inputs` TemplateSignerInput[] - `document_tag_id` string, nullable — This references the ID of a specific tag contained in a file of the signature request. - `text_value` string, nullable — Text prefill value. - `checkbox_value` boolean, nullable — Checkbox prefill value. - `date_value` string, date, nullable — Date prefill value. - `type` 'signature' | 'date' | 'text' | 'checkbox' | 'attachment' | 'radio' | 'dropdown' — Type of input. - `content_type` 'signature' | 'initial' | 'stamp' | 'date' | 'checkbox' | 'text' | 'full_name' | 'first_name' | 'last_name' | 'company' | 'title' | 'email' | 'attachment' | 'radio' | 'dropdown' — Content type of input. - `is_required` boolean — Whether or not the input is required. - `page_index` integer, required — Index of page that the input is on. - `document_id` string, nullable — Document identifier. - `dropdown_choices` string[], nullable — When the input is of the type `dropdown` this values will be filled with all the dropdown options. - `group_id` string, nullable — When the input is of type `radio` they can be grouped to gather with this identifier. - `coordinates` object — Where the input is located on a page. - `x` number — Relative x coordinate to the page the input is on, ranging from 0 to 1. - `y` number — Relative y coordinate to the page the input is on, ranging from 0 to 1. - `dimensions` object — The size of the input. - `width` number — Relative width to the page the input is on, ranging from 0 to 1. - `height` number — Relative height to the page the input is on, ranging from 0 to 1. - `label` string, nullable — The label field is used especially for text, attachment, radio, and checkbox type inputs. - `read_only` boolean — Indicates whether this input is read-only (cannot be modified by signers). - `validation` union — Specifies the formatting rules that signers must follow for text field inputs. If set, this validation is mandatory. - union — Specifies the formatting rules that signers must follow for text field inputs. If set, this validation is mandatory. The format can be selected from a predefined list of options (e.g., email, phone number, date) or defined using a custom regular expression. - SignRequestSignerInputEmailValidation — Specifies the formatting rules that signers must follow for text field inputs. If set, this validation is mandatory. - … - SignRequestSignerInputCustomValidation — Specifies the custom validation rules for a text field input by the signer. If set, this validation is mandatory. - … - SignRequestSignerInputZIPValidation — Specifies the validation rules for a text field input by the signer. If set, this validation is mandatory. - … - SignRequestSignerInputZIP4Validation — Specifies the validation rules for a text field input by the signer. If set, this validation is mandatory. - … - SignRequestSignerInputSSNValidation — Specifies the validation rules for a text field input by the signer. If set, this validation is mandatory. - … - SignRequestSignerInputNumberWithPeriodValidation — Specifies the number with period formatting rules for a text field input by the signer. If set, this validation is mandatory. - … - SignRequestSignerInputNumberWithCommaValidation — Specifies the number with comma formatting rules for a text field input by the signer. If set, this validation is mandatory. - … - SignRequestSignerInputDateISOValidation — Specifies the ISO date formatting rules for a text field input by the signer. If set, this validation is mandatory. The date format follows `YYYY-MM-DD` pattern. - … - SignRequestSignerInputDateUSValidation — Specifies the US date formatting rules for a text field input by the signer. If set, this validation is mandatory. The date format follows `MM/DD/YYYY` pattern. - … - SignRequestSignerInputDateEUValidation — Specifies the date formatting rules used in Europe for a text field input by the signer. If set, this validation is mandatory. The date format follows `DD/MM/YYYY` pattern. - … - SignRequestSignerInputDateAsiaValidation — Specifies the date formatting rules used in Asia for a text field input by the signer. If set, this validation is mandatory. The date format follows `YYYY/MM/DD` pattern. - … - object, nullable — The definition for a null schema type in OpenAPI `3.0`. - `email` string, nullable — Email address of the signer. - `role` 'signer' | 'approver' | 'final_copy_reader' — Defines the role of the signer in the signature request. A role of `signer` needs to sign the document, a role `approver` approves the document and a `final_copy_reader` role only receives the final signed document and signing log. - `is_in_person` boolean — Used in combination with an embed URL for a sender. After the sender signs, they will be redirected to the next `in_person` signer. - `order` integer — Order of the signer. - `signer_group_id` string, nullable — If provided, this value points signers that are assigned the same inputs and belongs to same signer group. A signer group is not a Box Group. It is an entity that belongs to the template itself and can only be used within Box Sign requests created from it. - `label` string, nullable — A placeholder label for the signer set by the template creator to differentiate between signers. - `public_id` string — An identifier for the signer. This can be used to identify a signer within the template. - `is_password_required` boolean, nullable — If true for signers with a defined email, the password provided when the template was created is used by default. If true for signers without a specified / defined email, the creator needs to provide a password when using the template. - `is_phone_number_required` boolean, nullable — If true for signers with a defined email, the phone number provided when the template was created is used by default. If true for signers without a specified / defined email, the template creator needs to provide a phone number when creating a request. - `login_required` boolean, nullable — If true, the signer is required to login to access the document. - `additional_info` object — Additional information on which fields are required and which fields are not editable. - `non_editable` string[] — Non editable fields. - `required` object — Required fields. - `signers` array[] — Required signer fields. - string[] - `ready_sign_link` object, nullable — 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. - `url` string — The URL that can be sent to signers. - `name` string, nullable — Request name. - `instructions` string, nullable — Extra instructions for all signers. - `folder_id` string, nullable — 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. - `is_notification_disabled` boolean — Whether to disable notifications when a signer has signed. - `is_active` boolean — Whether the ready sign link is enabled or not. - `custom_branding` object, nullable — Custom branding applied to notifications and signature requests. - `company_name` string, nullable — Name of the company. - `logo_uri` string, nullable — Custom branding logo URI in the form of a base64 image. - `branding_color` string, nullable — Custom branding color in hex. - `email_footer_text` string, nullable — Content of the email footer. - `request_flow` string, nullable — The sign flow of sign requests created from the template. Values can include `standard` or `cfr11`. ## Other responses - `401` — Returned when the access token provided in the `Authorization` header is not recognized or not provided. - `default` — An unexpected client error. --- [API](https://skmtc.net/box/apis/platform-api.md) · [All operations](https://skmtc.net/box/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/box/platform-api/revisions/ba8f087e1a4d/schema)