General

List templates

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

GET

/templates

List templates

curl --request GET \
  --url 'https://app.fynk.com/v1/api/templates?sort_by=name&sort_direction=asc&filter%5Barchived%5D=true&filter%5Bquery%5D=%3Cstring%3E&filter%5Blocale%5D=de-AT&filter%5Bteams%5D=322cecc9-44fe-4f10-b27d-77768abfeba2&filter%5Bteam_unassigned%5D=true&filter%5Btags%5D=58ac52bb-8885-4580-88c1-7a7bc772c87d%2C3213a2cd-7d86-4881-a7c3-53fca9593d6a&filter%5Btag_and%5D=true&filter%5Bexcluded_tags%5D=ed8d2db3-0321-4d0d-bae9-31e43a95e6b8&filter%5Bstatus%5D=draft&page=123&per_page=123' \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "archived_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "links": {
        "show": "https:..."
      },
      "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"
        }
      ],
      "published": true,
      "sequential_signing": true,
      "signature_type": "aes",
      "updated_at": "2023-11-07T05:31:56Z",
      "uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2"
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>"
  },
  "meta": {
    "current_page": 123,
    "from": 123,
    "last_page": 123,
    "links": [
      {
        "active": true,
        "label": "<string>",
        "url": "<string>"
      }
    ],
    "path": "<string>",
    "per_page": 123,
    "to": 123,
    "total": 123
  }
}

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

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

sort_byenum<string> | nullquery

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

Available options: name, created_at, updated_at, archived_at

sort_directionenum<string> | nullquery

Default is desc

Available options: asc, desc

filter[archived]enum<string>query

Available options: true, false

filter[query]stringquery

query will be matched against the Template's name

Maximum string length: 255

filter[locale]stringquery

Pattern: ^[a-z]{2}(?:-[A-Z]{2})?$

Example: de-AT

filter[teams]stringquery

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

Example: 322cecc9-44fe-4f10-b27d-77768abfeba2

filter[team_unassigned]enum<string>query

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.

Available options: true

filter[tags]stringquery

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.

Example: 58ac52bb-8885-4580-88c1-7a7bc772c87d,3213a2cd-7d86-4881-a7c3-53fca9593d6a

filter[tag_and]enum<string>query

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

Available options: true

filter[excluded_tags]stringquery

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

Example: ed8d2db3-0321-4d0d-bae9-31e43a95e6b8

filter[status]enum<string>query

Available options: draft, published

pageinteger | nullquery

Required range: 1 <= x

per_pageinteger | nullquery

Required range: 1 <= x <= 100

Response

Paginated set of TemplateMinimalResource

dataobject[]required

Show child attributes

linksobjectrequired

Show child attributes

metaobjectrequired

Show child attributes

Still need help? Share an idea