---
title: "Get template recipients"
method: GET
path: "/document/{template_id}/template/routing/detail"
---

# Get template recipients

`GET /document/{template_id}/template/routing/detail`

## Request

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

This endpoint allows API users to retrieve detailed routing information for a template, including signers, viewers, approvers, and CC recipients, along with their specific roles and signing order.

## Response `200`

OK

- object
  - `cc` string[]: A list of email addresses that will receive a carbon copy of the document.
  - `cc_step` object[]: A list of CC recipients assigned to specific steps in the signing order.
    - `name` string: The display name for the CC recipient.
    - `step` integer: The specific step in the signing order when the email should be sent.
    - `email` string: The email address of the CC recipient.
  - `viewers` object[]: A list of users with view-only permissions.
    - `name` string: The display name of the viewer.
    - `contact_id` string: The unique identifier of the contact linked to the document.
    - `inviter_role` boolean: If true, the viewer can invite others.
    - `default_email` string: The email address of the viewer. Note: If `inviter_role` is `true`, this defaults to the document owner's email (retrieved from `GET /user`) and the email input will be locked in the UI.
    - `signing_order` integer: The step order for the viewer.
  - `approvers` object[]: A list of users required to approve the document.
    - `name` string: The display name of the approver.
    - `inviter_role` boolean: If true, the approver can invite others.
    - `default_email` string: The email address of the approver. Note: If `inviter_role` is `true`, this defaults to the document owner's email (retrieved from `GET /user`) and the email input will be locked in the UI.
    - `signing_order` integer: The step order for the approver.
    - `authentication` object: Authentication settings used to verify the recipient identity.
      - `type` 'phone' | 'password', required: Authentication type used for the recipient authentication during the signing session.
      - `phone` string: Phone number used to authenticate the recipient. Required inside `authentication` object with the `phone` method.
      - `method` 'sms' | 'phone_call': Method of the `phone` authentication type. Required inside `authentication` object with the `phone` authentication type.
      - `password` string: Password set for the recipient authentication. Required inside the `authentication` object with the `password` authentication type.
      - `sms_message` string: Custom sms message sent to the recipient, containing the `{password}` placeholder. Used with the `sms` method. Without this parameter, the recipient receives a default sms with an autogenerated password.
    - `expiration_days` integer: Number of days before the approval request expires.
  - `attributes` object: General attributes regarding the document's completion settings and branding.
    - `brand_id` string: The unique identifier of the brand to apply.
    - `on_complete` string: The action to take when the document is completed.
    - `redirect_uri` string: The URL to redirect users to after signing.
  - `routing_details` object[]: A list of signers and their role configurations.
    - `name` string: The display name of the recipient role.
    - `role_id` string: The unique identifier of the role.
    - `inviter_role` boolean: If set to `true`, designates the document owner (current API user) as the recipient for this role. This corresponds to the 'I am recipient' setting in the UI.
    - `default_email` string: The email address of the recipient. Note: If `inviter_role` is `true`, this defaults to the document owner's email (retrieved from `GET /user`) and the email input will be locked in the UI.
    - `signing_order` integer: The order in the signing workflow.
  - `invite_link_instructions` string: Custom instructions to be displayed when the invite link is accessed.

## Other responses

- `400`: - Document not found.

---

[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)