v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

Template Operations

Show template

<small>Requires an API token with the Template Reader role.</small>

Shows details of a single template.

Entries with the multi_select value type are only included in the dynamic_fields and metadata_values lists if you are using API version 2026-04-02 or newer.

get/templates/{template}

Path parameters

templatestring required

The template UUID

Response

TemplateDetailResource

Example response

{
  "data": {
    "uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2",
    "name": "Employment Contract",
    "description": "Template for an employment contract",
    "locale": "de-AT",
    "parties": [
      {
        "uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f",
        "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "reference": "Employer",
        "entity_name": "Demo Inc.",
        "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ"
      }
    ],
    "teams": [
      {
        "uuid": "281b685e-4b29-4618-8231-3822537b139d",
        "name": "HR"
      }
    ],
    "signatories": [
      {
        "uuid": "76b8e0ad-e9cd-4c21-98b1-cd0003423ec2",
        "first_name": "Emily",
        "last_name": "Miller",
        "email": "miller@example.com",
        "mobile_phone": "+447951123456",
        "title": "Sales Manager",
        "profile_photo_url": "https://ui-avatars.com/api/?name=EM",
        "party_uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f"
      }
    ],
    "dynamic_fields": [
      {
        "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
        "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "Gross salary",
        "settings": {
          "currencies": [
            "EUR",
            "USD"
          ]
        },
        "format": {
          "decimals": 2,
          "decimal_separator": ".",
          "thousands_separator": ","
        },
        "question": "What is the employee's gross salary in EUR?"
      }
    ],
    "metadata_values": [
      {
        "uuid": "4ed6c60b-bc4f-4390-bbf5-ed384e3443c9",
        "metadata": {
          "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
          "name": "discount_rate",
          "display_name": "Discount Rate",
          "settings": {
            "currencies": [
              "EUR",
              "USD"
            ]
          },
          "description": "The discount rate applied to the company valuation in a follow-on financing round.",
          "keywords": "discount, rate, valuation",
          "prompt": "Extract the discount rate percentage from the document."
        },
        "reference_dynamic_field_uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc"
      }
    ],
    "tags": [
      {
        "uuid": "58ac52bb-8885-4580-88c1-7a7bc772c87d",
        "name": "Warranty",
        "color": "#615fff"
      }
    ]
  }
}