---
title: "Get template recipient"
method: GET
path: "/template/recipient/{recipientId}"
tags: ["Template Recipients"]
deprecated: true
---

# Get template recipient

`GET /template/recipient/{recipientId}`

> **Deprecated.**

Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Returns a single recipient. If you want to retrieve all the recipients for a template, use the "Get Template" endpoint.

## Path parameters

- `recipientId` number, required

## Response `200`

Successful response

- object
  - `envelopeId` string, required
  - `role` 'CC' | 'SIGNER' | 'VIEWER' | 'APPROVER' | 'ASSISTANT', required
  - `readStatus` 'NOT_OPENED' | 'OPENED', required
  - `signingStatus` 'NOT_SIGNED' | 'SIGNED' | 'REJECTED', required
  - `sendStatus` 'NOT_SENT' | 'SENT', required
  - `id` number, required
  - `email` string, required
  - `name` string, required
  - `token` string, required
  - `documentDeletedAt` string, nullable, required
  - `expired` string, nullable, required
  - `expiresAt` string, nullable, required
  - `expirationNotifiedAt` string, nullable, required
  - `signedAt` string, nullable, required
  - `authOptions` object, nullable, required
    - `accessAuth` string[], required
    - `actionAuth` string[], required
  - `signingOrder` number, nullable, required
  - `rejectionReason` string, nullable, required
  - `fields` object[], required
    - `envelopeId` string, required
    - `envelopeItemId` string, required
    - `type` 'SIGNATURE' | 'FREE_SIGNATURE' | 'INITIALS' | 'NAME' | 'EMAIL' | 'DATE' | 'TEXT' | 'NUMBER' | 'RADIO' | 'CHECKBOX' | 'DROPDOWN', required
    - `id` number, required
    - `secondaryId` string, required
    - `recipientId` number, required
    - `page` number, required
    - `positionX` unknown, required
    - `positionY` unknown, required
    - `width` unknown, required
    - `height` unknown, required
    - `customText` string, required
    - `inserted` boolean, required
    - `fieldMeta` union, required
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop', required
        - `type` 'signature', required
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop'
        - `type` 'initials', required
        - `textAlign` 'left' | 'center' | 'right'
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop'
        - `type` 'name', required
        - `textAlign` 'left' | 'center' | 'right'
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop', required
        - `type` 'email', required
        - `textAlign` 'left' | 'center' | 'right'
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop', required
        - `type` 'date', required
        - `textAlign` 'left' | 'center' | 'right'
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop'
        - `type` 'text', required
        - `text` string
        - `characterLimit` number
        - `textAlign` 'left' | 'center' | 'right'
        - `lineHeight` number, nullable
        - `letterSpacing` number, nullable
        - `verticalAlign` 'top' | 'middle' | 'bottom' | 'null', nullable
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop'
        - `type` 'number', required
        - `numberFormat` string, nullable
        - `value` string
        - `minValue` number, nullable
        - `maxValue` number, nullable
        - `textAlign` 'left' | 'center' | 'right'
        - `lineHeight` number, nullable
        - `letterSpacing` number, nullable
        - `verticalAlign` 'top' | 'middle' | 'bottom' | 'null', nullable
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop'
        - `type` 'radio', required
        - `values` object[]
          - `id` number, required
          - `checked` boolean, required
          - `value` string, required
        - `direction` 'vertical' | 'horizontal', required
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop'
        - `type` 'checkbox', required
        - `values` object[]
          - `id` number, required
          - `checked` boolean, required
          - `value` string, required
        - `validationRule` string
        - `validationLength` number
        - `direction` 'vertical' | 'horizontal', required
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `overflow` 'auto' | 'horizontal' | 'vertical' | 'crop'
        - `type` 'dropdown', required
        - `values` object[]
          - `value` string, required
        - `defaultValue` string
    - `documentId` number, nullable
    - `templateId` number, nullable
  - `documentId` number, nullable
  - `templateId` number, nullable

## Other responses

- `400` — Invalid input data
- `401` — Authorization not provided
- `403` — Insufficient access
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.net/documenso/apis/documenso-v2-api.md) · [All operations](https://skmtc.net/documenso/apis/documenso-v2-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/documenso/documenso-v2-api/revisions/3db245102197/schema)