---
title: "List templates"
method: GET
path: "/templates"
tags: ["General"]
---

# List templates

`GET /templates`

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

Lists the [templates](/#templates) available in your account.

## Filtering
The template list can be filtered by a number of different attributes. The available filter attributes are listed
in the [Query Parameters](/operations/v1.templates.index#Query-Parameters) section of this page, under `filter`.

To specify filters, use array notation in the request query string to specify one or more `filter` values.

For example, to filter for archived templates with a name that contains the string "Arbeitsvertrag", the query
string should contain: `filter[archived]=true&filter[query]=Arbeitsvertrag`

## Sorting

To specify the order that templates should be returned in, use the `sort_by` and `sort_direction` query string
parameters.

For example, to sort by the `name` attribute in ascending order, the query string should contain:
`sort_by=name&sort_direction=asc`

## Query parameters

- `sort_by` 'name' | 'created_at' | 'updated_at' | 'archived_at', nullable
- `sort_direction` 'asc' | 'desc', nullable
- `filter[archived]` 'true' | 'false'
- `filter[query]` string
- `filter[locale]` string
- `filter[teams]` string
- `filter[team_unassigned]` 'true'
- `filter[tags]` string
- `filter[tag_and]` 'true'
- `filter[excluded_tags]` string
- `filter[status]` 'draft' | 'published'
- `page` integer, nullable
- `per_page` integer, nullable

## Response `200`

Paginated set of `TemplateMinimalResource`

- object
  - `data` TemplateMinimalResource[], required
    - `uuid` string, required
    - `name` string, required
    - `locale` string, required
    - `published` boolean, required
    - `signature_type` 'aes' | 'qes' | 'ses', required
    - `sequential_signing` boolean, required — When true, require setting an order for signatures
    - `created_at` string, date-time, nullable, required
    - `updated_at` string, date-time, nullable, required
    - `archived_at` string, date-time, nullable, required
    - `parties` TemplatePartySnippetResource[], required — The initial set of people and/or organizations that will be included as parties in documents created from this template
      - `uuid` string, required
      - `ref_uuid` string, required — A static reference identifier, allowing parties in documents to be matched their corresponding party in the document's source template.
      - `reference` string, nullable, required — A generic reference for the party
      - `entity_name` string, nullable, required — The actual name of the party. i.e. name of the company or person. May be null if the party was created via the Template's "set later" option
      - `address` string, nullable, required
      - `scope` 'internal' | 'internal_and_external', required
      - `is_internal_party` boolean, required — Indicates whether this party is linked to an account party (internal) or is standalone (external)
      - `created_at` string, date-time, nullable, required
      - `updated_at` string, date-time, nullable, required
    - `links` object, required
      - `show` string, required
  - `links` object, required
    - `first` string, nullable, required
    - `last` string, nullable, required
    - `prev` string, nullable, required
    - `next` string, nullable, required
  - `meta` object, required
    - `current_page` integer, required
    - `from` integer, nullable, required
    - `last_page` integer, required
    - `links` object[], required — Generated paginator links.
      - `url` string, nullable, required
      - `label` string, required
      - `active` boolean, required
    - `path` string, nullable, required — Base path for paginator generated URLs.
    - `per_page` integer, required — Number of items shown per page.
    - `to` integer, nullable, required — Number of the last item in the slice.
    - `total` integer, required — Total number of items being paginated.

## Other responses

- `401` — Unauthenticated
- `403` — Authorization error
- `422` — Validation error

---

[API](https://skmtc.dev/fynk/apis/fynk-api-reference.md) · [All operations](https://skmtc.dev/fynk/apis/fynk-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fynk/fynk-api-reference/revisions/9657a6757f59/schema)