Template Operations

Show global template

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

GET

/global-templates/{template}

curl --request GET \
  --url https://app.fynk.com/v1/api/global-templates/{template} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "global_template_attribution_url": "<string>",
    "global_template_author_name": "John Doe",
    "global_template_license_name": "MIT",
    "global_template_license_url": "<string>",
    "locale": "de-AT",
    "name": "Employment Contract",
    "parties": [
      {
        "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ",
        "created_at": "2023-11-07T05:31:56Z",
        "entity_name": "Demo Inc.",
        "is_internal_party": true,
        "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "reference": "Employer",
        "scope": "internal",
        "updated_at": "2023-11-07T05:31:56Z",
        "uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f"
      }
    ],
    "updated_at": "2023-11-07T05:31:56Z",
    "uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2"
  }
}

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

templatestringrequired

The template UUID

Response

GlobalTemplateDetailResource

dataobjectrequired

Show child attributes

Still need help? Share an idea