---
title: "Get document group"
url: "https://docs.signnow.com/docs/document-group/operations/get-documentgroup"
type: "endpoint"
section: "document-group"
slug: "document-group/operations/get-documentgroup"
method: "GET"
path: "/documentgroup/{document_group_id}"
operation_id: "get-documentgroup"
authorization: "bearer"
---

# Get document group

`GET /documentgroup/{document_group_id}`

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.

## Authorization

bearer

## Path Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `document_group_id` | string | Yes |  |

## Responses

### 200

* Success
* Success with email_group block

**Example** (`Success`)

```json
{
  "id": "d6XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "state": "pending",
  "documents": [
    {
      "id": "d4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "roles": [
        "Candidate",
        "HR manager",
        "Viewer 2",
        "Viewer 3"
      ],
      "settings": [],
      "thumbnail": {
        "large": "https://api.signnow.com/document/d4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=large",
        "small": "https://api.signnow.com/document/d4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=small",
        "medium": "https://api.signnow.com/document/d4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=medium"
      },
      "document_name": "Offerletter",
      "field_invites": [
        {
          "id": "5aXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "short_link_url": null,
          "signature_type": null,
          "payment_request": null
        }
      ],
      "allowed_to_remove": true,
      "origin_document_id": "7cXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "has_unassigned_field": false,
      "has_credit_card_number": false
    },
    {
      "id": "d6XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "roles": [
        "CEO",
        "Employee",
        "HR manager",
        "Viewer 1"
      ],
      "settings": [],
      "thumbnail": {
        "large": "https://api.signnow.com/document/d6XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=large",
        "small": "https://api.signnow.com/document/d6XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=small",
        "medium": "https://api.signnow.com/document/d6XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=medium"
      },
      "document_name": "EMPLOYMENTCONTRACT",
      "field_invites": [
        {
          "id": "7dXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "short_link_url": null,
          "signature_type": null,
          "payment_request": null
        },
        {
          "id": "14XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "short_link_url": null,
          "signature_type": null,
          "payment_request": null
        }
      ],
      "allowed_to_remove": true,
      "origin_document_id": "2dXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "has_unassigned_field": false,
      "has_credit_card_number": false
    }
  ],
  "folder_id": "edXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "invite_id": "c3XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "group_name": "Jessica Moore onboarding package",
  "share_info": {
    "role": "owner",
    "is_personally_shared_to_others": false
  },
  "mail_provider": null,
  "freeform_invite": {
    "id": null
  },
  "scheduled_invite": null,
  "email_action_on_complete": null,
  "document_group_attributes": {
    "from_name": "Sample Sender",
    "from_email": "owner@email.com"
  },
  "originator_organization_settings": [
    {
      "value": "0",
      "setting": "no_user_signature_return"
    },
    {
      "value": "https://app.signnow.com/webapp/",
      "setting": "invite_completion_redirect_url"
    },
    {
      "value": "https://app.signnow.com/webapp/",
      "setting": "invite_decline_redirect_url"
    },
    {
      "value": "0",
      "setting": "required_preset_signature_name"
    },
    {
      "value": "0",
      "setting": "require_email_subject"
    },
    {
      "value": "0",
      "setting": "require_login_for_signing"
    },
    {
      "value": "0",
      "setting": "logout_on_signing"
    },
    {
      "value": "0",
      "setting": "front_end_session_length"
    },
    {
      "value": "0",
      "setting": "add_signature_stamp_with_name"
    },
    {
      "value": "0",
      "setting": "cfr_title_21_part_11"
    },
    {
      "value": "0",
      "setting": "require_authentication_for_invites"
    },
    {
      "value": "1",
      "setting": "document_guide"
    },
    {
      "value": "0",
      "setting": "disable_email_notifications"
    },
    {
      "value": "no",
      "setting": "block_login_via_social_networks"
    },
    {
      "value": "1",
      "setting": "common_experiments"
    },
    {
      "value": "0",
      "setting": "hide_decline_to_sign_option_in_signing_session"
    },
    {
      "value": "0",
      "setting": "hide_upgrade_subscription_button"
    },
    {
      "value": "",
      "setting": "do_no_consent_redirect_url"
    },
    {
      "value": "0",
      "setting": "lock_signing_date_by_default"
    },
    {
      "value": "0",
      "setting": "allow_download_certificate"
    },
    {
      "value": "0",
      "setting": "have_merged_document_group_option"
    },
    {
      "value": "1",
      "setting": "guide_signers_only_through_required_fields"
    },
    {
      "value": "30",
      "setting": "invite_expiration_days"
    },
    {
      "value": "0",
      "setting": "allow_big_attachment_file"
    },
    {
      "value": "0",
      "setting": "allow_big_count_of_attachment_fields_per_document"
    },
    {
      "value": "0",
      "setting": "enable_hyperlink_field"
    },
    {
      "value": "0",
      "setting": "disable_download_action_in_editor"
    },
    {
      "value": "bottom",
      "setting": "signature_stamp_position"
    },
    {
      "value": "0",
      "setting": "enable_pki"
    },
    {
      "value": "1",
      "setting": "save_signer_signature_and_initials"
    },
    {
      "value": "1",
      "setting": "auto_apply_signatures_and_initials_to_document_fields"
    },
    {
      "value": "0",
      "setting": "receive_signer_email_after_sent_field_invite_to_yourself"
    },
    {
      "value": "0",
      "setting": "allow_edit_document_after_signing"
    },
    {
      "value": "off",
      "setting": "every_signature_and_initials_field_requires_user_authentication"
    },
    {
      "value": "0",
      "setting": "enable_render_pages_in_editor_as_images"
    },
    {
      "value": "0",
      "setting": "enable_team_admin_move_docs"
    },
    {
      "value": "0",
      "setting": "disable_email_recipients"
    },
    {
      "value": "0",
      "setting": "allow_team_admin_rename_docs"
    },
    {
      "value": "0",
      "setting": "allow_qes"
    },
    {
      "value": "0",
      "setting": "enable_qes"
    },
    {
      "value": "https://www.signnow.com/",
      "setting": "invite_canceled_redirect_url"
    },
    {
      "value": "https://app.signnow.com/webapp/",
      "setting": "save_draft_redirect_url"
    },
    {
      "value": "0",
      "setting": "add_signers_name_to_document_history_header"
    }
  ]
}
```

**Example** (`Example 1`)

```json
{
  "id": "bcXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "state": "completed",
  "documents": [
    {
      "id": "19XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "roles": [
        "Signer 1"
      ],
      "thumbnail": {
        "large": "https://example.com/document/19XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=large",
        "small": "https://example.com/document/19XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=small",
        "medium": "https://example.com/document/19XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=medium"
      },
      "document_name": "Sample document",
      "origin_document_id": "73XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "has_unassigned_field": false,
      "has_credit_card_number": false
    },
    {
      "id": "6fXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "roles": [
        "Employer Representative"
      ],
      "thumbnail": {
        "large": "https://example.com/document/6fXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=large",
        "small": "https://example.com/document/6fXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=small",
        "medium": "https://example.com/document/6fXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=medium"
      },
      "document_name": "Sample document 1",
      "field_invites": [],
      "origin_document_id": "76XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "has_unassigned_field": false,
      "has_credit_card_number": false
    }
  ],
  "invite_id": "47XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "group_name": "Sample document group",
  "project_id": null,
  "share_info": {
    "role": "owner",
    "is_personally_shared_to_others": false
  },
  "mail_provider": null,
  "scheduled_invite": null,
  "email_action_on_complete": null,
  "document_group_attributes": {
    "from_name": "Jane Doe",
    "from_email": "sender@email.com"
  },
  "originator_organization_settings": []
}
```

**Example** (`Success with email_group block`)

```json
{
  "id": "02XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "state": "pending",
  "documents": [
    {
      "id": "07XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "roles": [
        "Signer 1"
      ],
      "settings": [],
      "thumbnail": {
        "large": "https://api.signnow.com/document/07XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=large",
        "small": "https://api.signnow.com/document/07XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=small",
        "medium": "https://api.signnow.com/document/07XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=medium"
      },
      "document_name": "Sample document",
      "field_invites": [
        {
          "id": "2bXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "email_group": {
            "id": "3eXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "name": "Sample group name"
          },
          "short_link_url": null,
          "signature_type": null,
          "payment_request": null
        }
      ],
      "allowed_to_remove": true,
      "origin_document_id": null,
      "has_unassigned_field": false,
      "has_credit_card_number": false
    }
  ],
  "folder_id": "11XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "invite_id": "22XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "group_name": "Group with email_group invite",
  "share_info": {
    "role": "owner",
    "is_personally_shared_to_others": false
  },
  "mail_provider": null,
  "freeform_invite": {
    "id": null
  },
  "scheduled_invite": null,
  "email_action_on_complete": null,
  "document_group_attributes": {
    "from_name": "Sample Sender",
    "from_email": "owner@email.com"
  },
  "originator_organization_settings": []
}
```

## Code Examples

> Replace `$SIGNNOW_ACCESS_TOKEN` and any `{placeholder}` values before running.

### cURL

```bash
curl -X GET \
  "https://api.signnow.com/documentgroup/{document_group_id}" \
  -H "Authorization: Bearer $SIGNNOW_ACCESS_TOKEN"
```

---
*Full reference: https://docs.signnow.com/docs/document-group/operations/get-documentgroup*