List templates
list-templatesGet a paginated list of the templates available to the current user.
Use this tool when:
You need to know which templates are available for creating documents from
You need to know which templates the user may edit in fynk. These will have a "url" field pointing to the edit page. No "url" means no permission to edit
By default, returns all active (non-archived) templates that the user has access to, with the most recently updated templates first. sort_by and sort_direction arguments can be used to control the sorting.
To keep responses small, each template is returned as a compact summary by default. Use the include parameter to request additional sections (parties, teams, tags, details, signing_settings, timestamps) when the user's question needs them, and prefer get-template-info when you need full information about a single template.
The various 'filter_' arguments can be used to limit the list of returned templates.
Active vs. archived templates
Only active — i.e. not archived — templates are returned by default. Archiving is not deletion: an archived template still exists and its past documents still reference it. Set filter_archived_state=all when the answer is meant to cover every template the account has, and retry with it if a call returns no results, before concluding that no matching template exists. Set filter_archived_state=archived only when the user asks specifically about archived templates. When picking a template to create a new document from, keep the default: an archived template is one the account has retired from use. A response only reveals which templates are archived if you request include=["timestamps"], which carries archived_at.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Which page of results to fetch | |
| include | No | Optional sections to include for each template, on top of the default compact summary. Allowed values: parties (the contracting entities the template defines, in compact form), teams (the teams the template is assigned to), tags (the account's own classification labels on the template), details (the template's description), signing_settings (signature type and sequential signing), timestamps (created_at, updated_at and archived_at — the last of these tells an archived template from an active one). Only request the sections you actually need; use get-template-info for full information about a single template. | |
| sort_by | No | Sort results by this field. The default is: updated_at | |
| per_page | No | How many results to return on each page | |
| filter_tags | No | A list of tag UUIDs. The default behavior is to match templates that have ANY of the given tags | |
| filter_query | No | Searches against the template's name | |
| filter_teams | No | A list of team UUIDs. Matches templates that belong to any of the given teams | |
| filter_locale | No | Locale code to filter by, e.g. "de" or "de-AT". Matches templates whose locale starts with the given value | |
| filter_status | No | Set to "published" to return only published templates, or "draft" to return only drafts | |
| filter_tag_and | No | If true, changes filter_tags behavior to only match templates that have ALL of the given tags. Sending false or omitting this filter has no effect | |
| sort_direction | No | The default is: desc | |
| filter_excluded_tags | No | A list of tag UUIDs. Templates with ANY of these tags will be excluded from the result | |
| filter_archived_state | No | Which templates to return, by archived state. "active" (the default) returns only active, non-archived templates; "archived" returns only archived templates; "all" returns both. Use "all" when the answer is meant to cover every template the account has; use "archived" only when the user asks specifically about archived templates. With "all" the response does not say which results are archived unless you also request include=["timestamps"]: archived_at is set on an archived template and null on an active one. Requires permission to manage templates — other users may only request "active" | active |
| filter_team_unassigned | No | If true, finds templates that are not assigned to any team. May be combined with filter_teams to find templates that are in the given filter_teams OR are unassigned. Sending false or omitting this filter has no effect |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| total | No | How many templates are available across all pages | |
| max_page | No | How many pages of results are available | |
| templates | No | ||
| in_app_url | No | A URL that opens the fynk app's templates list with the same filters, sorting and pagination applied. Give this to the user when they may want to view or work with this filtered template list in the fynk app | |
| current_page | No | Which page of results this is |