v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

Template Operations

Show global template

<small>Requires an API token with one of the following roles: Template Reader or Template Manager.</small>

Shows details of a single global template. Global templates are system-wide templates that can be cloned into your account using the clone endpoint.

To use a global template, you must first clone it into your account, then create documents from the cloned template using the existing create document from template endpoint.

get/global-templates/{template}

Path parameters

templatestring required

The template UUID

Response

GlobalTemplateDetailResource

Example response

{
  "data": {
    "uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2",
    "name": "Employment Contract",
    "locale": "de-AT",
    "global_template_author_name": "John Doe",
    "global_template_license_name": "MIT",
    "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"
      }
    ]
  }
}