---
title: "Retrieve a template"
method: GET
path: "/e-signature-templates/{id}"
tags: ["ESignature Templates"]
---

# Retrieve a template

`GET /e-signature-templates/{id}`

## Response `200`

Returns the object if a valid identifier is provided, and returns an error otherwise.

- ESignatureTemplate
  - `id` string, required
  - `isTestMode` boolean
  - `title` string, required
  - `description` string
  - `emailMessage` string
  - `documents` ESignatureTemplateDocument[]
    - `id` string
    - `name` string
    - `pageCount` number
    - `entryPads` ESignatureEntryPad[]
      - `id` string
      - `signerId` string, required — Id of the signer
      - `type` 'signature' | 'initials' | 'stamp' | 'date' | 'text' | 'checkbox' | 'name' | 'notary_public_profile_info' | 'email', required
      - `left` number, required — Offset from the left. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.
      - `top` number, required — Offset from the top. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.
      - `height` number, required — Height of the entry pad. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.
      - `width` number, required — Width of the entry pad. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.
      - `pageIndex` number, required — Page index whereby the entry pad is contained in the document.
      - `isOptional` boolean — Set to true if the entry pad is optional.
      - `metadata` unknown
  - `signers` ESignatureTemplateSigner[]
    - `id` string, required
    - `name` string, required
    - `attachmentRequests` ESignatureSignerAttachmentRequest[]
      - `id` string
      - `name` string, required
      - `description` string
      - `isOptional` boolean — Set to true if the request is optional
      - `isConfidential` boolean — Set to true if the attachment should not be shared with other signers; only the owner
    - `specialRoles` ESignatureSignerSpecialRoleEnum[]
    - `viewRestrictions` ESignatureSignerViewRestrictionEnum[]
  - `ccRecipients` ESignatureTemplateRecipient[]
    - `id` string, required
    - `name` string, required
  - `orderedSigners` boolean — Signers are sent by order
  - `owner` string
  - `kind` 'REGULAR' | 'EASY_SIGN'
  - `packageFolderId` string — Package folder that the esp is part of
  - `customBrandItemId` string — Id of the applicable custom brand item to apply to this eSignature template
  - `customBrandItem` CustomBrandItem
    - `id` string
    - `ownerId` string — Public id of the owner
    - `name` string, required — Name of the custom brand item
    - `logoSrc` string, required — Url of the logo
    - `isDefault` boolean — Mark whether the default is default
    - `emailNotification` CustomBrandItemEmailNotification
      - `senderName` string, required — The name that is sent when an email from Pactima is sent out. Placeholders {{firstName}} and {{lastName}} can be used
      - `colorTheme` object, required
        - `headerBackground` string, required
        - `headerText` string, required
        - `buttonBackground` string, required
        - `buttonText` string, required
        - `linkColor` string, required
    - `signingCeremony` CustomBrandItemSigningCeremony, required
      - `colorTheme` object, required
        - `headerBackground` string, required
        - `buttonBackground` string, required
        - `buttonText` string, required
    - `whiteLabelConfig` CustomBrandItemWhiteLabelConfig
      - `domainNames` string[]
      - `rootCSS` object
      - `notificationEmailAddress` string, email
      - `footerDetails` object
        - `inlineItems` string[]
        - `copyrightItem` string, html
      - `pathsConfig` object
        - `basePath` string
        - `basePathAuthenticated` string
  - `ownerDetails` OwnerDetails
    - `firstName` string
    - `lastName` string
    - `publicId` string
    - `email` string
  - `allTemplateFields` ESignatureTemplateField[]
    - `name` string, required
    - `required` boolean

---

[API](https://skmtc.net/pactima/apis/esignature-packages-api.md) · [All operations](https://skmtc.net/pactima/apis/esignature-packages-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pactima/esignature-packages-api/versions/1570128383ef/schema)