---
title: "Get a template"
method: GET
path: "/templates/{id}"
tags: ["Templates"]
---

# Get a template

`GET /templates/{id}`

The API endpoint provides the functionality to retrieve information about a document template.

## Path parameters

- `id` integer, required

## Response `200`

OK

- object
  - `id` integer, required — Unique identifier of the document template.
  - `slug` string, required — Unique slug of the document template.
  - `name` string, required — The name of the template.
  - `preferences` object, required — Template preferences.
  - `schema` object[], required — List of documents attached to the template.
    - `attachment_uuid` string, required — Unique identifier of attached document to the template.
    - `name` string, required — Name of the attached document to the template.
  - `fields` object[], required — List of fields to be filled in the template.
    - `uuid` string, required — Unique identifier of the field.
    - `submitter_uuid` string, required — Unique identifier of the submitter that filled the field.
    - `name` string, required — Field name.
    - `type` 'heading' | 'text' | 'signature' | 'initials' | 'date' | 'number' | 'image' | 'checkbox' | 'multiple' | 'file' | 'radio' | 'select' | 'cells' | 'stamp' | 'payment' | 'phone' | 'verification' | 'kba' | 'strikethrough', required — Type of the field (e.g., text, signature, date, initials).
    - `required` boolean, required — Indicates if the field is required.
    - `preferences` object — Field display preferences.
      - `font_size` integer — Font size of the field value in pixels.
      - `font_type` string — Font type of the field value.
      - `font` string — Font family of the field value.
      - `color` string — Font color of the field value.
      - `background` string — Field box background color.
      - `align` string — Horizontal alignment of the field text value.
      - `valign` string — Vertical alignment of the field text value.
      - `format` string — The data format for different field types.
      - `price` number — Price value of the payment field. Only for payment fields.
      - `currency` string — Currency value of the payment field. Only for payment fields.
      - `mask` boolean — Indicates if the field is masked on the document.
      - `reasons` string[] — An array of signature reasons to choose from.
    - `areas` object[], required — List of areas where the field is located in the document.
      - `x` number, required — X coordinate of the area where the field is located in the document.
      - `y` number, required — Y coordinate of the area where the field is located in the document.
      - `w` number, required — Width of the area where the field is located in the document.
      - `h` number, required — Height of the area where the field is located in the document.
      - `attachment_uuid` string, required — Unique identifier of the attached document where the field is located.
      - `page` integer, required — Page number of the attached document where the field is located.
  - `submitters` object[], required — The list of submitters for the template.
    - `name` string, required — The name of the submitter.
    - `uuid` string, required — Unique identifier of the submitter.
  - `author_id` integer, required — Unique identifier of the author of the template.
  - `archived_at` string, nullable, required — Date and time when the template was archived.
  - `created_at` string, required — The date and time when the template was created.
  - `updated_at` string, required — The date and time when the template was last updated.
  - `source` 'native' | 'api' | 'embed', required — Source of the template.
  - `external_id` string, nullable, required — Your application-specific unique string key to identify this template within your app.
  - `folder_id` integer, required — Unique identifier of the folder where the template is located.
  - `folder_name` string, required — Folder name where the template is located.
  - `shared_link` boolean — Indicates if the template is accessible by link.
  - `author` object, required
    - `id` integer, required — Unique identifier of the author.
    - `first_name` string, required — First name of the author.
    - `last_name` string, required — Last name of the author.
    - `email` string, required — Author email.
  - `documents` object[], required — List of documents attached to the template.
    - `id` integer, required — Unique identifier of the document.
    - `uuid` string, required — Unique identifier of the document.
    - `url` string, required — URL of the document.
    - `preview_image_url` string, required — Document preview image URL.
    - `filename` string, required — Document filename.

---

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