v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

General

List templates

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

Lists the 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 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

get/templates

Query parameters

sort_by'name' | 'created_at' | 'updated_at' | 'archived_at' nullable

Name of the field to sort the response by. Default is updated_at

sort_direction'asc' | 'desc' nullable

Default is desc

filter[archived]'true' | 'false'

filter[query]string

query will be matched against the Template's name

filter[locale]string

filter[teams]string

Comma-separated list of one or more team UUIDs to match. Matches templates that belong to any of the given teams.

filter[team_unassigned]'true'

Finds templates that not assigned to any team. May be combined with the teams filter to find templates that are in the given teams or are unassigned.

filter[tags]string

Comma-separated list of one or more tag UUIDs to match. The default behavior is to match templates that have any of the given tags.

filter[tag_and]'true'

Changes tags behavior to only match templates that have all of the given tags.

filter[excluded_tags]string

Comma-separated list of one or more tag UUIDs to exclude. Templates with any of these tags will be excluded from the result.

filter[status]'draft' | 'published'

pageinteger nullable

per_pageinteger nullable

Response

Paginated set of TemplateMinimalResource

Example response

{
  "data": [
    {
      "uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2",
      "name": "Employment Contract",
      "locale": "de-AT",
      "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"
        }
      ],
      "links": {
        "show": "https:..."
      }
    }
  ]
}