Get template details
Retrieves the details of an eSign template including its name, roles, and free-text fields. Requires the apiTemplatingEsign feature to be enabled for your organization.
| Path Parameters |
|---|
id uuid — REQUIREDThe unique identifier (UUID) of the template |
| Responses |
|---|
200
Template details retrieved successfully | Schema — OPTIONAL |
|---|
id uuid — OPTIONAL | templateName string — OPTIONAL | freeTextFields object[] — OPTIONALThese fields are for document generation. When a session is created with these values provided, the values will be
embedded into the pdf document as readonly printed text in the location where these tags were placed in the template. id uuid — OPTIONAL | name string — OPTIONAL |
| roles object[] — OPTIONALA list of roles used within this template. id uuid — OPTIONALThe role id. To create a session from a template, this value needs to be referenced in each participant object. | name string — OPTIONAL | description string — OPTIONALDescription for this role. |
|
|
400
Bad request — id is not a valid UUID | Schema — OPTIONAL |
|---|
detail string — OPTIONAL | error string — OPTIONAL | message string — OPTIONAL | help string — OPTIONAL |
|
401
Unauthorized — apiTemplatingEsign feature not enabled | Schema — OPTIONAL |
|---|
detail string — OPTIONAL | error string — OPTIONAL | message string — OPTIONAL | help string — OPTIONAL |
|
| Schema — OPTIONAL |
|---|
detail string — OPTIONAL | error string — OPTIONAL | message string — OPTIONAL | help string — OPTIONAL |
|