---
title: "List templates"
method: GET
path: "/v1/accounts/{accountId}/templates"
tags: ["Templates"]
---

# List templates

`GET /v1/accounts/{accountId}/templates`

## Request

- Base URL: `https://api.assinafy.com.br`
- URL: `https://api.assinafy.com.br/v1/accounts/{accountId}/templates`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`

List the templates of a workspace.

The `status` field of a template is one of:

| Status | Description |
|--------|-------------|
| `uploading` | The template is being uploaded. |
| `uploaded` | The template has been uploaded. |
| `processing` | The template is being processed. |
| `ready` | The template is ready to use. |
| `failed` | The template processing has failed. |

[Copy as Markdown](https://api.assinafy.com.br/v1/docs/markdown?method=get&path=%2Fv1%2Faccounts%2F%7BaccountId%7D%2Ftemplates) [Open in ChatGPT](https://chatgpt.com/?q=Read%20the%20API%20documentation%20at%20https%3A%2F%2Fapi.assinafy.com.br%2Fv1%2Fdocs%2Fmarkdown%3Fmethod%3Dget%26path%3D%252Fv1%252Faccounts%252F%257BaccountId%257D%252Ftemplates%20and%20help%20me%20integrate%20this%20endpoint.) [Open in Claude](https://claude.ai/new?q=Read%20the%20API%20documentation%20at%20https%3A%2F%2Fapi.assinafy.com.br%2Fv1%2Fdocs%2Fmarkdown%3Fmethod%3Dget%26path%3D%252Fv1%252Faccounts%252F%257BaccountId%257D%252Ftemplates%20and%20help%20me%20integrate%20this%20endpoint.)

## Path parameters

- `accountId` string, required

## Query parameters

- `search` string
- `page` integer
- `per-page` integer

## Response `200`

A page of templates (default_document_tags omitted in the list)

- object: Standard success wrapper. Operations add their own `data`.
  - `status` integer: HTTP status code, mirrored in the body.
  - `message` string: Human-readable message; empty on success.
  - `data` Template[]
    - `resource` string
    - `id` string
    - `name` string
    - `document_name` string, nullable: Default name for documents created from this template.
    - `message` string, nullable: Default invitation message.
    - `status` string: One of uploading, uploaded, processing, ready, failed.
    - `pages` TemplatePage[]
      - `id` string
      - `number` integer
      - `height` integer
      - `width` integer
      - `download_url` string
      - `fields` TemplateFieldPlacement[]
        - `id` string
        - `field_id` string
        - `role_id` string
        - `label` string
        - `display_settings` unknown
        - `created_at` string, date-time
        - `updated_at` string, date-time
    - `roles` TemplateRole[]
      - `id` string
      - `name` string
      - `assignment_type` string
      - `created_at` string, date-time
      - `updated_at` string, date-time
    - `tags` object[]
      - `id` string
      - `name` string
    - `default_document_tags` object[]: Applied to documents created from this template; only returned by the single-template endpoint.
      - `id` string
      - `name` string
    - `created_at` string, date-time
    - `updated_at` string, date-time

## Other responses

- `401`: Missing or invalid credentials.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/assinafy/apis/assinafy-api-reference.md) - [All operations](https://skmtc.dev/assinafy/apis/assinafy-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/assinafy/apis/assinafy-api-reference/revisions/f7da81a5567e?raw)