Get template info
get-template-infoGets information about a template.
Use this tool when:
You have a template's UUID and want to know more details about it.
e.g. when you want to create a document from the template and need to know which parties, dynamic fields, etc are available in the template.
Called with no include parameter, returns the template's identity, its parties, its teams, its description and its signing settings. Use include to name the sections you want instead - among them signatories, signature_blocks, dynamic_fields, conditions, metadata_values, tags and timestamps - and the response carries exactly those, so a question about one aspect of a template costs one section rather than the whole template.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| include | No | The sections the response carries, on top of the template's identity (uuid, name, locale, document type, published, url), which it always carries. Naming sections means exactly those: ask for one section and you pay for one, rather than for the whole template. If omitted, these are returned: parties, teams, details, signing_settings. | |
| template_uuid | Yes | UUID of the template to get information about |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | URL to open the template in fynk. Only present when your user has template editing permission | |
| name | No | Name of the template | |
| tags | No | The tags on the template. Tags are the account's own classification labels (e.g. relationship type, commercial significance, region), so they show which categories this account uses and can be filtered on with filter_tags. Only present when the 'tags' section is requested via the include parameter. | |
| uuid | No | Unique identifier for the template. Do not show to the user unless they ask for it | |
| teams | No | The teams the template is assigned to. Only present when the 'teams' section is requested via the include parameter. | |
| locale | No | Locale code, e.g. en-GB, de-AT. Prefer describing the locale in natural language (e.g. 'British English') rather than showing the raw code. | |
| parties | No | The contracting entities the template defines. Only present when the 'parties' section is requested via the include parameter. | |
| published | No | Indicates if the template is published (true) or a draft (false). Only published templates can be used by users without template management permission | |
| conditions | No | The template's conditions: rules over its dynamic fields deciding whether a passage of the template applies, and whether each currently holds. Use them to explain why a clause is or is not part of the template, and what would have to change to flip it. Only present when the 'conditions' section is requested via the include parameter. | |
| created_at | No | When the template was created. Only present when the 'timestamps' section is requested via the include parameter. | |
| updated_at | No | When the template was last updated. Only present when the 'timestamps' section is requested via the include parameter. | |
| archived_at | No | When the template was archived. Absent when the template is not archived. Only present when the 'timestamps' section is requested via the include parameter. | |
| description | No | Description of the template. Absent when the template has none. Only present when the 'details' section is requested via the include parameter. | |
| signatories | No | The individual people who sign documents created from this template. Distinct from parties: a signatory often signs on behalf of a party (e.g. a business), so a person may be a signatory without appearing as a party. Only present when the 'signatories' section is requested via the include parameter. | |
| _entity_type | No | Only relevant for tooling. Do not show to the user | |
| document_type | No | If present, indicates what kind of document this template creates. Absent when the template has no type assigned | |
| dynamic_fields | No | The template's dynamic fields and their values. Only present when the 'dynamic_fields' section is requested via the include parameter. | |
| signature_type | No | The eIDAS assurance level that will be used when signing documents created from this template. Absent when none has been chosen. Only present when the 'signing_settings' section is requested via the include parameter. | |
| metadata_values | No | The template's metadata fields and their values. Only present when the 'metadata_values' section is requested via the include parameter. | |
| signature_blocks | No | The places in the template that are signed. A block is bound either to a single signatory or to a party, in which case every signatory of that party signs it. Only present when the 'signature_blocks' section is requested via the include parameter. | |
| sequential_signing | No | Whether signatories must sign in a specific order. Only present when the 'signing_settings' section is requested via the include parameter. |