---
title: "Get pinned templates"
method: GET
path: "/v2/folders/{folder_id}/document-templates/pinned"
---

# Get pinned templates

`GET /v2/folders/{folder_id}/document-templates/pinned`

## Request

- Base URL: `https://api.signnow.com`
- URL: `https://api.signnow.com/v2/folders/{folder_id}/document-templates/pinned`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/signnow/apis/signnow-api/docs/v2/folders/:folder_id/document-templates/pinned/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows API users to get the pinned templates in the `Templates` folder or one of its subfolders.

**Notes**

* `folder_id` must be the ID of the `Templates` folder or one of its subfolders. For any other folder, the endpoint returns `400`.
* To get the ID of the `Templates` folder, call `GET /user/folder`.

## Response `200`

The pinned templates in the folder. `data` is empty if no templates are pinned.

* User has 1 pinned template
* User has no pinned templates

- object
  - `data` object[]: Pinned templates.
    - `id` string: ID of the template.
    - `tags` object[]: Tags assigned to the template.
      - `name` string: Name of the tag.
      - `type` string: Type of the tag, for example `system`.
      - `unique_id` string: ID of the tag.
    - `owner` string: Email address of the template owner.
    - `roles` object[]: Signer roles defined in the template.
      - `name` string: Name of the role.
      - `unique_id` string: ID of the role.
      - `signing_order` integer: Position of the role in the signing order.
    - `created` integer: Unix timestamp of when the template was created.
    - `updated` integer: Unix timestamp of the last template update.
    - `user_id` string: ID of the template owner.
    - `thumbnail` object: Links to the template thumbnail images.
      - `large` string: URL of the large thumbnail.
      - `small` string: URL of the small thumbnail.
      - `medium` string: URL of the medium thumbnail.
    - `page_count` integer: Number of pages in the template.
    - `signatures` object[]: Signatures applied to the template.
    - `attachments` object[]: File attachments in the template.
    - `version_time` integer: Unix timestamp of the template version.
    - `viewer_roles` object[]: Viewer roles defined in the template.
      - `name` string: Name of the role.
      - `unique_id` string: ID of the role.
      - `signing_order` integer: Position of the role in the signing order.
    - `document_name` string: Name of the template.
    - `recently_used` integer: Unix timestamp of when the template was last used to send an invite.
    - `routing_details` object[]: Invite routing configuration saved in the template.
      - `cc` string[]: Email addresses that receive a copy of the completed document.
      - `id` string: ID of the routing details record.
      - `data` object[]: Signer roles and their invite settings.
        - `name` string: Name of the role.
        - `role_id` string: ID of the role.
        - `attributes` object[]: Additional attributes of the role.
        - `inviter_role` boolean: `true` if the template owner is the recipient for this role.
        - `default_email` string: Default email address of the recipient for this role. Empty if not set.
        - `signing_order` integer: Position of the role in the signing order.
        - `decline_by_signature` boolean: Whether the recipient can decline by signature.
      - `cc_step` object[]: Steps after which `cc` recipients are notified.
      - `created` integer: Unix timestamp of when the routing details were created.
      - `updated` integer: Unix timestamp of the last update.
      - `viewers` object[]: Viewer roles and their invite settings.
      - `approvers` object[]: Approver roles and their invite settings.
      - `invite_link_instructions` string: Instructions shown with the invite link. Can be `null`.
    - `original_filename` string: Original filename of the uploaded file.
    - `document_group_template_info` object[]: Document group templates that include this template.
  - `meta` object: Response metadata.
    - `pagination` object: Pagination details.
      - `count` integer: Number of templates on this page.
      - `links` object[]: Links to other pages. Empty if there is one page.
      - `total` integer: Total number of pinned templates.
      - `per_page` integer: Maximum number of templates per page.
      - `total_pages` integer: Total number of pages.
      - `current_page` integer: Number of the current page.

## Other responses

- `400`: User folder {folder_id} is not Template folder or Template sub-folder.
- `403`: Folder {folder_id} doesn’t belong to a user.
- `404`: The folder does not exist.

---

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