--- title: "Get document group info (v.2)" url: "https://docs.signnow.com/docs/document-group/operations/get-document-group-info-v2" type: "endpoint" section: "document-group" slug: "document-group/operations/get-document-group-info-v2" method: "GET" path: "/v2/document-groups/{document_group_id}" operation_id: "get-document-group-info-v2" authorization: "bearer" --- # Get document group info (v.2) `GET /v2/document-groups/{document_group_id}` This endpoint allows API users to retrieve detailed information about a specific document group, including its documents, assigned roles, field and FreeForm invites, share info, owner details, and originator organization settings. Available to the document group owner and to any user invited on any step, regardless of the current invite or step status. **Notes** * Use the `include` query parameter to add optional data to the response. To request several values, separate them with commas, for example `?include=documents.fields,reminder`. Unknown values are ignored. * With `?include=documents.fields`, each item in `documents` contains a `fields` array. Without it, the response doesn't include `fields`, so existing integrations are not affected. * The objects in `fields` have the same format as the `fields` array of [`GET /document/{document_id}`](/docs/document/operations/get-document) and cover all field types it returns. * The response doesn't include dropdown options (`enumeration_options`) or checkbox groups (`checkbox_groups`). [`GET /document/{document_id}`](/docs/document/operations/get-document) returns them at the document level, so call it for each document that needs them. * To add or update fields, call [`PUT /document/{document_id}`](/docs/document/operations/edit-document) for each document. ## Authorization bearer ## Path Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `document_group_id` | string | Yes | ID of the document group. | ## Query Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `include=document_group_attributes` | string | No | If used, the response will contain document group attributes. | | `include=reminder` | string | No | If used, the response includes `general_expiration_time`, `general_expiration_days`, and `general_reminder` — defaults applied to all recipients in the invite. | | `include=documents.fields` | string | No | If used, each item in `documents` contains a `fields` array with the fields of that document. | | `include=documents.freeform_invites` | string | No | If used, each item in `documents` contains a `freeform_invites` array with the FreeForm invites sent for that document. | | `include=documents.signatures` | string | No | If used, each item in `documents` contains a `signatures` array with the signatures added to that document. | | `include=entity_labels` | string | No | If used, the response contains `entity_labels`: the labels assigned to the document group. | | `include=origin_dgt` | string | No | If used, the response contains `origin_dgt`: the document group template the document group was created from. | | `include=recently_used` | string | No | If used, the response contains `recently_used`: the Unix timestamp of the last activity on the document group. | ## Responses ### 200 - Request with correct token - Request with email group - Request with FreeForm invite - Request with `include=documents.fields` - Request with `include=documents.signatures,entity_labels,origin_dgt,recently_used` **Example** (`Field invite`) ```json { "data": { "id": "d6XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Sample document group", "owner": { "id": "57XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "owner@email.com", "organization": { "id": "1eXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } }, "state": "pending", "created": 1774375376, "updated": 1777288567, "cc_emails": [], "documents": [ { "id": "d4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "owner": { "id": "57XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "owner@email.com" }, "roles": [ "Candidate", "HR manager", "Viewer 2", "Viewer 3" ], "updated": 1777288568, "settings": [], "folder_id": "edXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "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" }, "has_fields": true, "page_count": 1, "document_name": "Offerletter", "field_invites": [ { "id": "c9XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "HR manager", "action": "approve", "status": "pending", "created": 1777288568, "message": "Sample document group needs your signature.", "updated": 1777288568, "language": null, "compliance": { "cfr": null }, "email_group": { "id": null, "name": null }, "signer_email": "signer1@email.com", "signing_order": 1, "email_statuses": [ { "status": "sent", "created_at": 1777288569, "last_reaction_at": 1777288569 }, { "status": "mail_open", "created_at": 1777289723, "last_reaction_at": 1777289723 } ], "short_link_url": null, "signature_type": null, "expiration_days": 30, "expiration_time": 1779880568, "payment_request": null, "is_full_declined": false, "next_reminder_at": null, "sms_sent_statuses": [], "password_protected": "0", "signer_phone_invite": null }, { "id": "5aXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Candidate", "action": "sign", "status": "created", "created": 1777288568, "message": "Sample document group needs your signature.", "updated": 1777288568, "language": null, "compliance": { "cfr": null }, "email_group": { "id": null, "name": null }, "signer_email": "signer2@email.com", "signing_order": 2, "email_statuses": [], "short_link_url": null, "signature_type": null, "expiration_days": 30, "expiration_time": null, "payment_request": null, "is_full_declined": false, "next_reminder_at": null, "sms_sent_statuses": [], "password_protected": "0", "signer_phone_invite": null }, { "id": "54XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Viewer 2", "action": "view", "status": "created", "created": 1777288568, "message": "Sample document group needs your signature.", "updated": 1777288568, "language": null, "compliance": { "cfr": null }, "email_group": { "id": null, "name": null }, "signer_email": "signer3@email.com", "signing_order": 3, "email_statuses": [], "short_link_url": null, "signature_type": null, "expiration_days": 30, "expiration_time": null, "payment_request": null, "is_full_declined": false, "next_reminder_at": null, "sms_sent_statuses": [], "password_protected": "0", "signer_phone_invite": null }, { "id": "f7XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Viewer 3", "action": "view", "status": "created", "created": 1777288568, "message": "Sample document group needs your signature.", "updated": 1777288568, "language": null, "compliance": { "cfr": null }, "email_group": { "id": null, "name": null }, "signer_email": "signer4@email.com", "signing_order": 4, "email_statuses": [], "short_link_url": null, "signature_type": null, "expiration_days": 30, "expiration_time": null, "payment_request": null, "is_full_declined": false, "next_reminder_at": null, "sms_sent_statuses": [], "password_protected": "0", "signer_phone_invite": null } ], "allow_to_remove": true, "shared_with_team": null, "origin_document_id": "7cXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "has_unassigned_field": false, "has_credit_card_number": false }, { "id": "d6XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "owner": { "id": "57XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "owner@email.com" }, "roles": [ "CEO", "Employee", "HR manager", "Viewer 1" ], "updated": 1777288568, "settings": [], "folder_id": "edXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "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" }, "has_fields": true, "page_count": 1, "document_name": "EMPLOYMENTCONTRACT", "field_invites": [ { "id": "fbXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "HR manager", "action": "approve", "status": "pending", "created": 1777288568, "message": "Sample document group needs your signature.", "updated": 1777288568, "language": null, "compliance": { "cfr": null }, "email_group": { "id": null, "name": null }, "signer_email": "signer1@email.com", "signing_order": 1, "email_statuses": [ { "status": "sent", "created_at": 1777288569, "last_reaction_at": 1777288569 }, { "status": "mail_open", "created_at": 1777289723, "last_reaction_at": 1777289723 } ], "short_link_url": null, "signature_type": null, "expiration_days": 30, "expiration_time": 1779880568, "payment_request": null, "is_full_declined": false, "next_reminder_at": null, "sms_sent_statuses": [], "password_protected": "0", "signer_phone_invite": null }, { "id": "20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Viewer 1", "action": "view", "status": "created", "created": 1777288568, "message": "Sample document group needs your signature.", "updated": 1777288568, "language": null, "compliance": { "cfr": null }, "email_group": { "id": null, "name": null }, "signer_email": "signer3@email.com", "signing_order": 2, "email_statuses": [], "short_link_url": null, "signature_type": null, "expiration_days": 30, "expiration_time": null, "payment_request": null, "is_full_declined": false, "next_reminder_at": null, "sms_sent_statuses": [], "password_protected": "0", "signer_phone_invite": null }, { "id": "7dXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "CEO", "action": "sign", "status": "created", "created": 1777288568, "message": "Sample document group needs your signature.", "updated": 1777288568, "language": null, "compliance": { "cfr": null }, "email_group": { "id": null, "name": null }, "signer_email": "signer2@email.com", "signing_order": 3, "email_statuses": [], "short_link_url": null, "signature_type": null, "expiration_days": 30, "expiration_time": null, "payment_request": null, "is_full_declined": false, "next_reminder_at": null, "sms_sent_statuses": [], "password_protected": "0", "signer_phone_invite": null }, { "id": "14XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Employee", "action": "sign", "status": "created", "created": 1777288568, "message": "Sample document group needs your signature.", "updated": 1777288568, "language": null, "compliance": { "cfr": null }, "email_group": { "id": null, "name": null }, "signer_email": "signer4@email.com", "signing_order": 4, "email_statuses": [], "short_link_url": null, "signature_type": null, "expiration_days": 30, "expiration_time": null, "payment_request": null, "is_full_declined": false, "next_reminder_at": null, "sms_sent_statuses": [], "password_protected": "0", "signer_phone_invite": null } ], "allow_to_remove": true, "shared_with_team": null, "origin_document_id": "2dXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "has_unassigned_field": false, "has_credit_card_number": false } ], "folder_id": "edXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "invite_id": "c3XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "expires_at": 1779880568, "share_info": { "role": "owner", "is_team_shared": false, "is_personally_shared_to_others": false }, "owner_email": "owner@email.com", "sender_name": "Sample Sender", "completed_at": null, "sender_email": "owner@email.com", "mail_provider": null, "last_invite_id": "c3XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "sign_as_merged": true, "freeform_invite": { "id": null, "last_id": null, "message": null }, "pending_step_id": "acXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "general_reminder": { "remind_after": 3, "remind_before": 5, "remind_repeat": 7 }, "scheduled_invite": null, "general_expiration_days": 30, "general_expiration_time": null, "email_action_on_complete": null, "document_group_attributes": { "from_name": "Sample Sender", "from_email": "owner@email.com" }, "originator_organization_settings": [ { "value": "no", "setting": "digitally_sign_dowloaded_docs" }, { "value": "no", "setting": "electronic_consent_required" }, { "value": "0", "setting": "require_email_subject" }, { "value": "0", "setting": "require_authentication_for_invites" }, { "value": "https://www.signnow.com/", "setting": "invite_canceled_redirect_url" }, { "value": "https://app.signnow.com/webapp/", "setting": "invite_completion_redirect_url" }, { "value": "https://app.signnow.com/webapp/", "setting": "invite_decline_redirect_url" }, { "value": "https://app.signnow.com/webapp/", "setting": "save_draft_redirect_url" }, { "value": "0", "setting": "disable_branding_setup" }, { "value": "1", "setting": "guide_signers_only_through_required_fields" }, { "value": "1", "setting": "document_guide" }, { "value": "0", "setting": "required_preset_signature_name" }, { "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": "no_user_signature_return" }, { "value": "0", "setting": "disable_email_notifications" }, { "value": "no", "setting": "block_login_via_social_networks" }, { "value": "0", "setting": "hide_upgrade_subscription_button" }, { "value": "0", "setting": "hide_decline_to_sign_option_in_signing_session" }, { "value": "1", "setting": "common_experiments" }, { "value": "0", "setting": "have_merged_document_group_option" }, { "value": "0", "setting": "allow_download_certificate" }, { "value": "30", "setting": "invite_expiration_days" }, { "value": "0", "setting": "allow_big_count_of_attachment_fields_per_document" }, { "value": "0", "setting": "allow_big_attachment_file" }, { "value": "0", "setting": "enable_hyperlink_field" }, { "value": "0", "setting": "disable_download_action_in_editor" }, { "value": "bottom", "setting": "signature_stamp_position" }, { "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": "0", "setting": "enable_render_pages_in_editor_as_images" }, { "value": "off", "setting": "every_signature_and_initials_field_requires_user_authentication" }, { "value": "0", "setting": "enable_team_admin_move_docs" }, { "value": "0", "setting": "allow_team_admin_rename_docs" }, { "value": "0", "setting": "disable_email_recipients" }, { "value": "0", "setting": "allow_qes" }, { "value": "0", "setting": "enable_qes" }, { "value": "0", "setting": "add_signers_name_to_document_history_header" } ] } } ``` **Example** (`Freeform invite`) ```json { "data": { "id": "12XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Sample document group with freeform invite", "owner": { "id": "f7XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "owner@email.com", "organization": { "id": "e0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } }, "state": "pending", "created": 1686312228, "updated": 1686312300, "cc_emails": [], "documents": [ { "id": "07XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "owner": { "id": "f7XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "owner@email.com" }, "roles": [ "Signer 1" ], "updated": 1686312233, "settings": [], "folder_id": null, "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" }, "has_fields": false, "page_count": 1, "document_name": "Sample document", "field_invites": [], "allow_to_remove": true, "freeform_invites": [ { "id": "ffXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "signer@email.com", "status": "pending", "language": null, "email_statuses": [ { "status": "sent", "created_at": 1686312234, "last_reaction_at": 1686312234 }, { "status": "mail_open", "created_at": 1686398634, "last_reaction_at": 1686398634 } ] } ], "shared_with_team": null, "origin_document_id": null, "has_unassigned_field": false, "has_credit_card_number": false } ], "folder_id": null, "invite_id": "22XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "expires_at": null, "share_info": { "role": "owner", "is_team_shared": false, "is_personally_shared_to_others": false }, "owner_email": "owner@email.com", "sender_name": "Sample Sender", "completed_at": null, "sender_email": "owner@email.com", "mail_provider": null, "last_invite_id": "22XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "sign_as_merged": false, "freeform_invite": { "id": "22XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "last_id": "22XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "message": null }, "pending_step_id": null, "general_reminder": null, "scheduled_invite": null, "general_expiration_days": null, "general_expiration_time": null, "email_action_on_complete": null, "document_group_attributes": { "from_name": "Sample Sender", "from_email": "owner@email.com" }, "originator_organization_settings": [] } } ``` **Example** (`Signing completed`) ```json { "data": { "id": "02XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Group with email_group invite", "owner": { "id": "f7XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "owner@email.com", "organization": { "id": "e0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } }, "state": "completed", "created": 1686312228, "updated": 1777375000, "cc_emails": [], "documents": [ { "id": "07XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "owner": { "id": "57XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "owner@email.com" }, "roles": [ "Signer 1" ], "updated": 1777288568, "settings": [], "folder_id": "edXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "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" }, "has_fields": true, "page_count": 1, "document_name": "Sample document", "field_invites": [ { "id": "2bXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Signer 1", "action": "sign", "status": "fulfilled", "created": 1777288568, "message": "Sample document group needs your signature.", "updated": 1777288568, "language": null, "compliance": { "cfr": null }, "email_group": { "id": "3eXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Sample group name" }, "signer_email": "signer1@email.com", "signing_order": 1, "email_statuses": [ { "status": "sent", "created_at": 1777288569, "last_reaction_at": 1777288569 }, { "status": "mail_open", "created_at": 1777289723, "last_reaction_at": 1777289723 } ], "short_link_url": null, "signature_type": null, "expiration_days": 30, "expiration_time": 1779880568, "payment_request": null, "is_full_declined": false, "next_reminder_at": null, "sms_sent_statuses": [], "password_protected": "0", "signer_phone_invite": null } ], "allow_to_remove": true, "shared_with_team": null, "origin_document_id": null, "has_unassigned_field": false, "has_credit_card_number": false } ], "folder_id": null, "invite_id": "22XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "expires_at": null, "share_info": { "role": "owner", "is_team_shared": false, "is_personally_shared_to_others": false }, "owner_email": "owner@email.com", "sender_name": "Sample Sender", "completed_at": 1777375000, "sender_email": "owner@email.com", "mail_provider": null, "last_invite_id": "22XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "sign_as_merged": false, "freeform_invite": { "id": null, "last_id": null, "message": null }, "pending_step_id": null, "general_reminder": null, "scheduled_invite": null, "general_expiration_days": null, "general_expiration_time": null, "email_action_on_complete": null, "document_group_attributes": { "from_name": "Sample Sender", "from_email": "owner@email.com" }, "originator_organization_settings": [] } } ``` **Example** (`With document fields`) ```json { "data": { "id": "49XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Sample document group", "owner": { "id": "99XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "owner@email.com", "organization": { "id": "78XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } }, "state": "pending", "created": 1777288000, "updated": 1777288567, "cc_emails": [], "documents": [ { "id": "f4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "owner": { "id": "99XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "owner@email.com" }, "roles": [ "Signer 1", "Signer 2" ], "fields": [ { "id": "a9XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Signer 1", "type": "text", "role_id": "06XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_id": "a5XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "fulfiller": "signer1@email.com", "element_id": null, "originator": "owner@email.com", "json_attributes": { "x": 84, "y": 485, "bold": false, "font": "Arial", "name": "Text Field 5", "size": 12, "align": "left", "color": "000000", "width": 207, "height": 21, "italic": false, "valign": "top", "required": true, "font_size": 8, "max_chars": 0, "max_lines": 0, "underline": false, "arrangement": "none", "page_number": 0 }, "field_request_id": "a5XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "template_field_id": null, "field_request_canceled": null }, { "id": "64XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Signer 2", "type": "text", "role_id": "3eXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_id": "bdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "fulfiller": "signer2@email.com", "element_id": null, "originator": "owner@email.com", "json_attributes": { "x": 321, "y": 485, "bold": false, "font": "Arial", "name": "Text Field 7", "size": 12, "align": "left", "color": "000000", "width": 208, "height": 21, "italic": false, "valign": "top", "required": true, "font_size": 8, "max_chars": 0, "max_lines": 0, "underline": false, "arrangement": "none", "page_number": 0 }, "field_request_id": "bdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "template_field_id": null, "field_request_canceled": null }, { "id": "caXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Signer 1", "type": "signature", "role_id": "06XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_id": "90XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "fulfiller": "signer1@email.com", "element_id": null, "originator": "owner@email.com", "json_attributes": { "x": 83, "y": 444, "name": "Signature 1", "width": 208, "height": 25, "required": true, "page_number": 0, "allowed_types": [ "type", "draw", "upload" ] }, "field_request_id": "90XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "template_field_id": null, "field_request_canceled": null }, { "id": "9bXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Signer 2", "type": "signature", "role_id": "3eXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_id": "88XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "fulfiller": "signer2@email.com", "element_id": null, "originator": "owner@email.com", "json_attributes": { "x": 321, "y": 444, "name": "Signature 3", "width": 208, "height": 24, "required": true, "page_number": 0, "allowed_types": [ "type", "draw", "upload" ] }, "field_request_id": "88XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "template_field_id": null, "field_request_canceled": null } ], "updated": 1777288568, "settings": [], "folder_id": "d4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "thumbnail": { "large": "https://api.signnow.com/document/f4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=large", "small": "https://api.signnow.com/document/f4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=small", "medium": "https://api.signnow.com/document/f4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=medium" }, "has_fields": true, "page_count": 1, "document_name": "Subcontract agreement", "field_invites": [ { "id": "ffXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Signer 1", "action": "sign", "status": "pending", "created": 1777288568, "message": "Sample document group needs your signature.", "updated": 1777288568, "language": null, "compliance": { "cfr": null }, "email_group": { "id": null, "name": null }, "signer_email": "signer1@email.com", "signing_order": 1, "email_statuses": [ { "status": "sent", "created_at": 1777288569, "last_reaction_at": 1777288569 } ], "short_link_url": null, "signature_type": null, "expiration_days": 30, "expiration_time": 1779880568, "payment_request": null, "is_full_declined": false, "next_reminder_at": null, "sms_sent_statuses": [], "password_protected": "0", "signer_phone_invite": null }, { "id": "4cXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Signer 2", "action": "sign", "status": "pending", "created": 1777288568, "message": "Sample document group needs your signature.", "updated": 1777288568, "language": null, "compliance": { "cfr": null }, "email_group": { "id": null, "name": null }, "signer_email": "signer2@email.com", "signing_order": 1, "email_statuses": [ { "status": "sent", "created_at": 1777288569, "last_reaction_at": 1777288569 } ], "short_link_url": null, "signature_type": null, "expiration_days": 30, "expiration_time": 1779880568, "payment_request": null, "is_full_declined": false, "next_reminder_at": null, "sms_sent_statuses": [], "password_protected": "0", "signer_phone_invite": null } ], "allow_to_remove": true, "shared_with_team": null, "origin_document_id": null, "has_unassigned_field": false, "has_credit_card_number": false }, { "id": "83XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "owner": { "id": "99XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "owner@email.com" }, "roles": [ "Signer 1", "Viewer 1" ], "fields": [ { "id": "18XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Signer 1", "type": "checkbox", "role_id": "57XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_id": "10XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "fulfiller": "signer1@email.com", "element_id": null, "originator": "owner@email.com", "json_attributes": { "x": 253, "y": 687, "name": "Checkbox 1", "value": "Age 15-20", "width": 11, "height": 11, "required": false, "page_number": 0, "prefilled_text": "0" }, "field_request_id": "10XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "template_field_id": null, "field_request_canceled": null }, { "id": "13XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Signer 1", "type": "checkbox", "role_id": "57XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_id": "33XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "fulfiller": "signer1@email.com", "element_id": null, "originator": "owner@email.com", "json_attributes": { "x": 253, "y": 704, "name": "Checkbox 2", "value": "Age 20-30", "width": 11, "height": 11, "required": false, "page_number": 0, "prefilled_text": "0" }, "field_request_id": "33XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "template_field_id": null, "field_request_canceled": null }, { "id": "43XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Signer 1", "type": "checkbox", "role_id": "57XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_id": "c8XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "fulfiller": "signer1@email.com", "element_id": null, "originator": "owner@email.com", "json_attributes": { "x": 253, "y": 720, "name": "Checkbox 3", "value": "Age 30-40", "width": 11, "height": 11, "required": false, "page_number": 0, "prefilled_text": "0" }, "field_request_id": "c8XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "template_field_id": null, "field_request_canceled": null }, { "id": "c9XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Signer 1", "type": "enumeration", "role_id": "57XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_id": "9cXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "fulfiller": "signer1@email.com", "element_id": null, "originator": "owner@email.com", "json_attributes": { "x": 402, "y": 682, "bold": false, "font": "Arial", "name": "Dropdown 1", "size": 14, "align": "left", "color": "000000", "label": "Vacation type", "width": 103, "height": 12, "italic": false, "required": true, "font_size": 10, "underline": false, "page_number": 0, "custom_defined_option": "" }, "field_request_id": "9cXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "template_field_id": null, "field_request_canceled": null }, { "id": "45XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Signer 1", "type": "radiobutton", "radio": [ { "x": 100, "y": 671, "value": "Red", "width": 23, "height": 23, "checked": 0, "created": 1777288560, "radio_id": "bdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "page_number": 0, "json_attributes": [] }, { "x": 100, "y": 701, "value": "Green", "width": 23, "height": 23, "checked": 0, "created": 1777288560, "radio_id": "f4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "page_number": 0, "json_attributes": [] }, { "x": 100, "y": 730, "value": "Black", "width": 23, "height": 23, "checked": 0, "created": 1777288560, "radio_id": "c0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "page_number": 0, "json_attributes": [] } ], "role_id": "57XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_id": "abXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "fulfiller": "signer1@email.com", "element_id": null, "originator": "owner@email.com", "json_attributes": { "x": 100, "y": 671, "name": "Radio Group 1", "width": 23, "height": 23, "required": true, "page_number": 0 }, "field_request_id": "abXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "template_field_id": null, "field_request_canceled": null } ], "updated": 1777288568, "settings": [], "folder_id": "d4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "thumbnail": { "large": "https://api.signnow.com/document/83XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=large", "small": "https://api.signnow.com/document/83XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=small", "medium": "https://api.signnow.com/document/83XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=medium" }, "has_fields": true, "page_count": 1, "document_name": "Employment agreement", "field_invites": [ { "id": "ccXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Signer 1", "action": "sign", "status": "pending", "created": 1777288568, "message": "Sample document group needs your signature.", "updated": 1777288568, "language": null, "compliance": { "cfr": null }, "email_group": { "id": null, "name": null }, "signer_email": "signer1@email.com", "signing_order": 1, "email_statuses": [ { "status": "sent", "created_at": 1777288569, "last_reaction_at": 1777288569 } ], "short_link_url": null, "signature_type": null, "expiration_days": 30, "expiration_time": 1779880568, "payment_request": null, "is_full_declined": false, "next_reminder_at": null, "sms_sent_statuses": [], "password_protected": "0", "signer_phone_invite": null }, { "id": "e2XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Viewer 1", "action": "view", "status": "fulfilled", "created": 1777288568, "message": "Sample document group needs your signature.", "updated": 1777288568, "language": null, "compliance": { "cfr": null }, "email_group": { "id": null, "name": null }, "signer_email": "signer2@email.com", "signing_order": 1, "email_statuses": [ { "status": "sent", "created_at": 1777288569, "last_reaction_at": 1777288569 } ], "short_link_url": null, "signature_type": null, "expiration_days": 30, "expiration_time": null, "payment_request": null, "is_full_declined": false, "next_reminder_at": null, "sms_sent_statuses": [], "password_protected": "0", "signer_phone_invite": null } ], "allow_to_remove": true, "shared_with_team": null, "origin_document_id": null, "has_unassigned_field": false, "has_credit_card_number": false } ], "folder_id": "d4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "invite_id": "c8XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "expires_at": 1779880568, "share_info": { "role": "owner", "is_team_shared": false, "is_personally_shared_to_others": false }, "owner_email": "owner@email.com", "sender_name": "", "completed_at": null, "sender_email": "owner@email.com", "mail_provider": null, "last_invite_id": "c8XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "sign_as_merged": true, "freeform_invite": { "id": null, "last_id": null, "message": null }, "pending_step_id": "c7XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "scheduled_invite": null, "email_action_on_complete": null, "originator_organization_settings": [ { "value": "1", "setting": "document_guide" }, { "value": "30", "setting": "invite_expiration_days" } ] } } ``` **Example** (`Field invite with email group`) ```json { "data": { "id": "02XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Group with email_group invite", "owner": { "id": "f7XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "owner@email.com", "organization": { "id": "e0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } }, "state": "pending", "created": 1686312228, "updated": 1686312300, "cc_emails": [], "documents": [ { "id": "07XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "owner": { "id": "57XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "owner@email.com" }, "roles": [ "Signer 1" ], "updated": 1777288568, "settings": [], "folder_id": "edXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "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" }, "has_fields": true, "page_count": 1, "document_name": "Sample document", "field_invites": [ { "id": "2bXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Signer 1", "action": "sign", "status": "pending", "created": 1777288568, "message": "Sample document group needs your signature.", "updated": 1777288568, "language": null, "compliance": { "cfr": null }, "email_group": { "id": "3eXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Sample group name" }, "signer_email": "signer1@email.com", "signing_order": 1, "email_statuses": [ { "status": "sent", "created_at": 1777288569, "last_reaction_at": 1777288569 }, { "status": "mail_open", "created_at": 1777289723, "last_reaction_at": 1777289723 } ], "short_link_url": null, "signature_type": null, "expiration_days": 30, "expiration_time": 1779880568, "payment_request": null, "is_full_declined": false, "next_reminder_at": null, "sms_sent_statuses": [], "password_protected": "0", "signer_phone_invite": null } ], "allow_to_remove": true, "shared_with_team": null, "origin_document_id": null, "has_unassigned_field": false, "has_credit_card_number": false } ], "folder_id": null, "invite_id": "22XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "expires_at": 1779880568, "share_info": { "role": "owner", "is_team_shared": false, "is_personally_shared_to_others": false }, "owner_email": "owner@email.com", "sender_name": "Sample Sender", "completed_at": null, "sender_email": "owner@email.com", "mail_provider": null, "last_invite_id": "22XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "sign_as_merged": false, "freeform_invite": { "id": null, "last_id": null, "message": null }, "pending_step_id": "fdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "general_reminder": null, "scheduled_invite": null, "general_expiration_days": null, "general_expiration_time": null, "email_action_on_complete": null, "document_group_attributes": { "from_name": "Sample Sender", "from_email": "owner@email.com" }, "originator_organization_settings": [] } } ``` **Example** (`With signatures and origin template`) ```json { "data": { "id": "02XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Group with email_group invite", "owner": { "id": "f7XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "owner@email.com", "organization": { "id": "e0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } }, "state": "completed", "created": 1686312228, "updated": 1777375000, "cc_emails": [], "documents": [ { "id": "07XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "owner": { "id": "57XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "owner@email.com" }, "roles": [ "Signer 1" ], "updated": 1777288568, "settings": [], "folder_id": "edXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "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" }, "has_fields": true, "page_count": 1, "signatures": [ { "id": "5aXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "created": "1777374900", "user_id": "b0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } ], "document_name": "Sample document", "field_invites": [ { "id": "2bXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Signer 1", "action": "sign", "status": "fulfilled", "created": 1777288568, "message": "Sample document group needs your signature.", "updated": 1777288568, "language": null, "compliance": { "cfr": null }, "email_group": { "id": "3eXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Sample group name" }, "signer_email": "signer1@email.com", "signing_order": 1, "email_statuses": [ { "status": "sent", "created_at": 1777288569, "last_reaction_at": 1777288569 }, { "status": "mail_open", "created_at": 1777289723, "last_reaction_at": 1777289723 } ], "short_link_url": null, "signature_type": null, "expiration_days": 30, "expiration_time": 1779880568, "payment_request": null, "is_full_declined": false, "next_reminder_at": null, "sms_sent_statuses": [], "password_protected": "0", "signer_phone_invite": null } ], "allow_to_remove": true, "shared_with_team": null, "origin_document_id": null, "has_unassigned_field": false, "has_credit_card_number": false } ], "folder_id": null, "invite_id": "22XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "expires_at": null, "origin_dgt": { "id": "e1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "owner_id": "57XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "template_group_name": "Sample document group template" }, "share_info": { "role": "owner", "is_team_shared": false, "is_personally_shared_to_others": false }, "owner_email": "owner@email.com", "sender_name": "Sample Sender", "completed_at": 1777375000, "sender_email": "owner@email.com", "entity_labels": [], "mail_provider": null, "recently_used": 1777375000, "last_invite_id": "22XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "sign_as_merged": false, "freeform_invite": { "id": null, "last_id": null, "message": null }, "pending_step_id": null, "general_reminder": null, "scheduled_invite": null, "general_expiration_days": null, "general_expiration_time": null, "email_action_on_complete": null, "document_group_attributes": { "from_name": "Sample Sender", "from_email": "owner@email.com" }, "originator_organization_settings": [] } } ``` ### 400 - Request with Incorrect or missing token **Example** (`Example 1`) ```json { "code": 1537, "error": "invalid_token" } ``` **Example** (`Request with Incorrect or missing token`) ```json { "code": 1537, "error": "invalid_token" } ``` ### 403 - Request with token that belongs to a user who is not the document group owner, was not invited to the group, and has no shared access to it **Example** (`Example 1`) ```json { "errors": [ { "message": "Access to DocumentGroup is denied" } ] } ``` **Example** (`Access denied`) ```json { "errors": [ { "message": "Access to DocumentGroup is denied" } ] } ``` ### 404 - id does not exist - id is not active **Example** (`Example 1`) ```json { "errors": [ { "message": "Document group `` not found" } ] } ``` **Example** (`id is not active`) ```json { "errors": [ { "message": "Document group `` not found" } ] } ``` **Example** (`id does not exist`) ```json { "errors": [ { "message": "Document group `` not found" } ] } ``` ## Code Examples > Replace `$SIGNNOW_ACCESS_TOKEN` and any `{placeholder}` values before running. ### cURL ```bash curl -X GET \ "https://api.signnow.com/v2/document-groups/{document_group_id}" \ -H "Authorization: Bearer $SIGNNOW_ACCESS_TOKEN" ``` --- *Full reference: https://docs.signnow.com/docs/document-group/operations/get-document-group-info-v2*