---
title: "Get doc group recipients"
method: GET
path: "/v2/document-groups/{document_group_id}/recipients"
---

# Get doc group recipients

`GET /v2/document-groups/{document_group_id}/recipients`

## Request

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

This endpoint allows API users to retrieve the list of recipients of a document group invite.

## Response `200`

Success with email group block

- object
  - `data` object: Recipients of the document group, CC recipients, and documents not yet assigned to a recipient.
    - `cc` string[]: Email addresses of CC recipients.
    - `order_type` string: Recipient routing rule applied to all recipients in the invite. `at_the_same_time` - all at once; `recipient_order` - sequential by `order` parameter; `advanced_order` - advanced rules.
    - `recipients` object[]: Recipients of the document group invite.
      - `name` string: Name of the recipient.
      - `email` string: Email address of the recipient.
      - `order` integer: Position of the recipient in the signing order.
      - `documents` object[]: Documents the recipient receives, with the role and action for each.
        - `id` string: ID of the document.
        - `role` string: Name of the recipient role in the document.
        - `action` string: Action the recipient must perform in the document: `sign`, `view`, or `approve`.
      - `attributes` object: Invite settings of the recipient.
        - `email` string: Email address of the recipient. `null` if not set.
        - `message` string: Message of the invite email.
        - `subject` string: Subject of the invite email.
        - `reminder` object: Reminder settings of the invite.
          - `remind_after` integer: Number of days after the invite is sent before the first reminder.
          - `remind_before` integer: Number of days before expiration to send a reminder.
          - `remind_repeat` integer: Number of days between repeated reminders.
        - `document_id` string: ID of the document. `null` if not set.
        - `redirect_uri` string: URL the recipient is redirected to after completing the signing session.
        - `allow_reassign` string: `"1"` if the recipient can reassign the invite, otherwise `"0"`.
        - `authentication` object: Authentication settings of the recipient.
          - `type` string: Authentication type of the recipient, for example `password` or `phone`.
          - `value` string: Password the recipient must enter to open the documents.
        - `i_am_recipient` boolean: `true` if the sender is also a recipient.
        - `expiration_days` integer: Number of days before the invite expires.
        - `redirect_target` string: Where the redirect URL opens: `self` for the same tab or `blank` for a new tab.
        - `allow_forwarding` boolean: `true` if the recipient can reassign the invite to another email address.
        - `close_redirect_uri` string: URL the recipient is redirected to after selecting **Save Progress and Finish Later**.
        - `show_decline_button` boolean: `true` if the **Decline** button is shown on signature fields.
        - `decline_by_signature` integer: `1` if the recipient can decline the invite, otherwise `0`.
        - `decline_redirect_uri` string: URL the recipient is redirected to after declining the documents.
      - `email_group` object: Email group of the recipient. `id` is `null` if the recipient is not a group.
        - `id` unknown
      - `phone_invite` unknown
    - `general_reminder` object: Default `reminder` applied to all recipients in the invite.
      - `remind_after` integer: Days after invite is sent before a reminder is delivered.
      - `remind_before` integer: Days before expiration when a reminder is delivered.
      - `remind_repeat` integer: Days between repeated reminders.
    - `unmapped_documents` object[]: Documents and roles that are not assigned to any recipient.
      - `id` string: ID of the document.
      - `role` string: Name of the unassigned role in the document.
      - `action` string: Action required in the document: `sign`, `view`, or `approve`.
    - `general_expiration_days` integer: Default `expiration_days` applied to all recipients in the invite.
    - `allowed_unmapped_sign_documents` object[]: Documents with `sign` actions that are allowed to stay unassigned to a recipient.

## Other responses

- `400`: * Wrong, expired, or missing token.
- `403`: Access to DocumentGroup is denied.
- `404`: - Document group is not found. - Document with incorrect UID.

---

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