Get Template Details

Retrieve a single template's metadata plus its configured signers and fields.

Authentication

This endpoint requires a bearer token. See Authentication and API Keys.

Headers

Header	Required	Description
Authorization	required	`Bearer <BEARER_TOKEN>`

Parameters

Parameter	Type	Description
template_id required	string	The identifier of the template to retrieve. Use a `template_id` from List Templates.

Request body

Request body: None.

Request example

curl -X GET "https://toolkit.undersign.app/api/v1.1/templates/<template-uuid>" \
  -H "Authorization: Bearer <BEARER_TOKEN>"

Response

A successful response returns the template's metadata plus its signers_with_fields configuration.

Successful response

{
  "success": true,
  "request_id": "...",
  "timestamp": "...",
  "data": {
    "template_id": "<template-uuid>",
    "template_title": "...",
    "signers_with_fields": [
      {
        "id": "signer_1",
        "name": "Signer 1",
        "fields": [
          {
            "id": "...",
            "type": "signature",
            "required": true
          }
        ]
      }
    ]
  }
}

Response fields

The template metadata fields match List Templates. The additional signers_with_fields array contains the configured signer roles and their fields.

Field	Description
signers_with_fields	Array of signer roles with their assigned fields.
signers_with_fields.id	Role identifier.
signers_with_fields.name	Role name.
signers_with_fields.fields	Array of fields assigned to the role.
fields.id	Field identifier.
fields.type	Field type.
fields.required	Whether the field is required.

Response status & error codes

Code	Error code	Description
`200 OK`	`-`	Success. Returns signer slots with associated fields.
`404`	`TEMPLATE_NOT_FOUND`	Template not found or marked draft/deleted.
`429`	`RATE_LIMIT_EXCEEDED`	Too many requests (limit: 100/min). See Rate Limits.

Implementation guidance

This endpoint is useful for integrations that need to inspect a template's configured signers and fields, for example to understand what data a signer is expected to provide, or to review prefill fields before sending.

List Templates

Retrieve the templates available to your account.

Prefill Fields

Fields populated by the sender before signing.