Get Template Details - Lumin Developer Docs

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.

Hide child attributes

signer_roles.name

string

A label for the role (e.g., "Tenant", "Manager").

signer_roles.group

integer

Indicates signing order group (e.g., 1 = sign first, 2 = sign second).

tags

object[]

Merge tags embedded in the Sign template.

Hide child attributes

tags.name

string

The label or identifier of the tag.

tags.type

enum<string>

Type of tag, one of: merge_tag

Available options:

merge_tag

tags.is_required

boolean

Indicates whether the merge tag needs to be prefilled before the signature request can be completed.

fields

object[]

The form fields that appear in the template.

Hide child attributes

fields.name

string

The label or identifier of the form field.

fields.type

enum<string>

Type of field, one of: text, checkbox

Available options:

text,

checkbox

fields.is_required

boolean

Indicates whether the assigned signer must complete the field before the signature request can be completed.

fields.assigned_role

string

The role (as defined in the template) to which this field is assigned. If not set, the field may not be linked to a specific role and will be dismissed during signature request creation.

variables

object

The variables defined in the AgreementGen template.

Hide child attributes

variables.name

string

The label or identifier of the variable.

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.

Hide child attributes

collections.name

string

Collection identifier as declared in the template marker (e.g., Opportunity.LineItems). Use this value as the key in the collections object of the Create Agreement, Generate Document from Template, or Send Signature Request from Template payloads.

collections.type

enum<string>

Marker scope the collection drives.

table_row_repeat — duplicates one or more body rows per item (<<TableStart:>> / <<TableEnd:>>).

Available options:

table_row_repeat

collections.variables

string[]

Variable names referenced inside the loop body (e.g., Product.Name, Product.Quantity). Callers should include these keys in each item object of the collections.<name> array at generation time. Missing collection variables render as empty strings.

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.