Skip to main content
GET
Get Template Details
This endpoint requires the following scope:templates

Authorizations

X-API-Key
string
header
required

Provide your API key in the X-API-Key header, e.g., X-API-Key: YOUR_API_KEY.

Path Parameters

template_id
string
required

ID of the template.

Response

Returns the template details.

template_id
string

Unique identifier for the template

type
enum<string>

Template file type. One of: pdf, lumin

Available options:
pdf,
lumin
name
string

Name of the template

signing_type
enum<string>

Defines how recipients are expected to sign:

  • ORDER: Signers sign in a specific sequence.
  • SAME_TIME: All signers can sign in parallel. AgreementGen and PDF templates currently only supports signing_type as SAME_TIME.
Available options:
ORDER,
SAME_TIME
signer_roles
object[]

Describes the signer roles defined in the template.

tags
object[]

Merge tags embedded in the Sign template.

fields
object[]

The form fields that appear in the template.

variables
object

The variables defined in the AgreementGen template.

collections
object[]

Table-scoped collections referenced by row-loop markers in the template.

Empty array ([]) when the template has no markers. Applies to AgreementGen templates only — returned as [] for Sign and PDF templates.

created_at
integer<unix-epoch>

The Unix timestamp when the template was first created.

updated_at
integer<unix-epoch>

The Unix timestamp of the last update to the template.