×
TemplateContains information about the templates you and your team have createdContains information about the templates you and your team have created
Template
Response Object.
template_id
The id of the Template.
title
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
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.
metadata
The metadata attached to the template.
signer_roles
An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
name
The name of the Role.
order
If signer order is assigned this is the 0-based index for this role.
cc_roles
An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.
name
The name of the Role.
documents
An array describing each document associated with this Template. Includes form field data for each document.
name
Name of the associated file
index
Document ordering, the lowest index is displayed first and the highest last.
field_groups
An array of Form Field Group objects.
name
The name of the form field group.
rule
The rule used to validate checkboxes in the form field group. See checkbox field grouping.
form_fields
An array of Form Field objects containing the name and type of each named textbox and checkmark field.
api_id
A unique id for the form field.
name
The name of the form field.
type
The type of this form field. See field types.
x
The horizontal offset in pixels for this form field.
y
The vertical offset in pixels for this form field.
width
The width in pixels of this form field.
height
The height in pixels of this form field.
required
Boolean showing whether or not this field is required.
group
The name of the group this field is in. If this field is not a group, this defaults to null.
custom_fields
An array of Custom Field objects
name
The name of the Custom Field.
type
The type of this Custom Field. Only 'text' and 'checkbox' are currently supported.
x
The horizontal offset in pixels for this field.
y
The vertical offset in pixels for this field.
width
The width in pixels of this field.
height
The height in pixels of this field.
required
Boolean showing whether or not this field is required.
group
The name of the group this field is in. If this field is not a group, this defaults to null.
avg_text_length
Average text length in custom field.
num_lines
Number of lines.
num_chars_per_line
Number of character per line.
named_form_fields
DEPRECATED Use "form_fields" under the "documents" array instead.
reusable_form_id
DEPRECATED
accounts
An array of the Accounts that can use this Template.
account_id
The id of the Account.
email_address
The email address associated with the Account.
is_locked
Returns true if the user has been locked out of their account by a team admin.
is_paid_hs
Returns true if the user has a paid HelloSign account.
is_paid_hf
Returns true if the user has a paid HelloFax account.
quotas
An object detailing remaining monthly quotas.
templates_left
API templates remaining.
api_signature_requests_left
API signature requests remaining.
documents_left
Signature requests remaining.
is_creator
True if you are the owner of this template, false if it's been shared with you by a team member.
is_embedded
True if this template was created using an embedded flow, false if it was created on our website.
can_edit
Indicates whether edit rights have been granted to you by the owner (always true if that's you).
is_locked
True if you exceed Template quota; these can only be used in test mode. False if the template is included with the Template quota; these can be used at any time.
ACTION
URI - Description
List Templates
GET /template/list
Lists your Templates.Description
Returns a list of the Templates that are accessible by you.Take a look at our search guide to learn more about querying templates.
Request Parameters
account_id optional
Which account to return Templates for. Must be a team member. Use "all" to indicate all team members. Defaults to your account.
page optional
Which page number of the Template List to return. Defaults to 1.
page_size optional
Number of objects to be returned per page. Must be between 1 and 100. Default is 20.
query optional
String that includes search terms and/or fields to be used to filter the Template objects.
Response Parameters
list_info
A ListInfo object
num_pages
Total number of pages available
num_results
Total number of objects available
page
Number of the page being returned
page_size
Objects returned per page
templates
An array of Template objects.
Example request / response
GET https://[api
key]:@api.hellosign.com/v3/template/list