Skip to main content
GET
/
templates
/
{template_id}
Get Template Details
curl --request GET \
  --url https://api.luminpdf.com/v1/templates/{template_id} \
  --header 'X-API-Key: <api-key>'
{
  "template_id": "sign_123456",
  "type": "pdf",
  "name": "Mutual NDA",
  "signing_type": "ORDER",
  "signer_roles": [
    {
      "name": "Tenant",
      "group": 1
    },
    {
      "name": "Client",
      "group": 2
    }
  ],
  "tags": [
    {
      "name": "owner.name",
      "type": "merge_tag",
      "is_required": true
    }
  ],
  "fields": [
    {
      "name": "hasCompleted",
      "type": "checkbox",
      "is_required": true,
      "assigned_role": "Tenant"
    }
  ],
  "variables": [
    {
      "name": "Company.Name",
      "value": "ACME Corp"
    },
    {
      "name": "Document.Name",
      "value": "NDA Document"
    }
  ],
  "created_at": 1748456885430,
  "updated_at": 1748456885430
}

Documentation Index

Fetch the complete documentation index at: https://developers.luminpdf.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

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.