---
title: "Get document group"
method: GET
path: "/documentgroup/{document_group_id}"
---

# Get document group

`GET /documentgroup/{document_group_id}`

## Request

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

This endpoint allows API users to retrieve details about a specific document group, including its documents, assigned roles, and any FreeForm or field invites. 
 
The `invite_id` property indicates the group invite if it exists, or is null if no invite has been created.

## Response `200`

Successful response. Returns the document group with its documents, field invites, and settings. If an invite was sent to an email group, the field invite contains the `email_group` object.

- object
  - `id` string: Unique identifier of the document group.
  - `state` 'created' | 'pending' | 'canceled' | 'completed' | 'declined' | 'correction': Current state of the document group. Possible values: `created` — the document group has been created; `pending` — an invite has been sent and is awaiting signing; `canceled` — the document group invite was canceled; `completed` — all signing steps are completed; `declined` — one of the signers declined to sign; `correction` — the document group is in correction mode.
  - `documents` object[]: List of documents in the document group.
    - `id` string: ID of the document.
    - `roles` string[]: Roles assigned in the document. Empty if the document has no roles.
    - `settings` object[]: Settings of the document.
    - `thumbnail` object: Thumbnail URLs of the first page of the document.
      - `large` string: URL of the large thumbnail.
      - `small` string: URL of the small thumbnail.
      - `medium` string: URL of the medium thumbnail.
    - `document_name` string: Name of the document.
    - `field_invites` object[]: Field invites sent for the document.
      - `id` string: ID of the field invite.
      - `email_group` object: Email group the invite was sent to. `id` and `name` are `null` if the invite was sent to a single recipient.
        - `id` string: See the parent object.
        - `name` string: See the parent object.
      - `short_link_url` string: Short link to the invite. `null` if not generated.
      - `signature_type` string: Type of signature required from the signer. `null` if not set.
      - `payment_request` string: Payment request attached to the invite. `null` if there is none.
    - `allowed_to_remove` boolean: `true` if the document can be removed from the document group.
    - `origin_document_id` string: ID of the source document if this document was created as a copy. `null` otherwise.
    - `has_unassigned_field` boolean: `true` if the document has fields not assigned to any role.
    - `has_credit_card_number` boolean: `true` if the document has a credit card number field.
  - `folder_id` string: Unique identifier of the folder that contains the document group, or `null` if the group is not in a folder.
  - `invite_id` string: Unique identifier of the active group invite, or `null` if no invite has been created.
  - `group_name` string: Display name of the document group.
  - `share_info` object: Sharing information for the document group, including the requesting user's role.
    - `role` string: Access level of the current user: `owner`, `sender`, or `viewer`.
    - `is_team_shared` boolean: `true` if the item is shared with a team.
    - `workspace_role` string: Role of the current user in the workspace. `null` if not applicable.
    - `is_personally_shared_to_others` boolean: `true` if the current user shared the item with other users.
  - `mail_provider` unknown
  - `freeform_invite` object: Information about the FreeForm invite associated with this document group. The `id` is `null` if no FreeForm invite has been created.
    - `id` string: ID of the FreeForm invite. `null` if no FreeForm invite was sent.
  - `scheduled_invite` unknown
  - `email_action_on_complete` unknown
  - `document_group_attributes` object: Custom attributes of the document group, such as `from_email` and `from_name`. An empty array if none are set.
    - `from_name` string: Sender name shown in the emails of the document group.
    - `from_email` string: Sender email address shown in the emails of the document group.
  - `originator_organization_settings` object[]: Organization-level settings inherited from the document group owner's organization.
    - `value` string: Value of the setting, as a string.
    - `setting` string: Name of the setting.

## Other responses

- `400`: * Wrong, expired, or missing token. * The document group doesn't exist. * The document group belongs to another user.

---

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