--- title: "Get document group history" url: "https://docs.signnow.com/docs/document-group/operations/get-documentgroup-document-group-id-historyfull" type: "endpoint" section: "document-group" slug: "document-group/operations/get-documentgroup-document-group-id-historyfull" method: "GET" path: "/documentgroup/{document_group_id}/historyfull" operation_id: "get-documentgroup-document-group-id-historyfull" authorization: "bearer" --- # Get document group history `GET /documentgroup/{document_group_id}/historyfull` This endpoint allows API users to retrieve the full history of a document group. For the events: * `document_group_authentication_success` * `document_group_authentication_failure` the response may contain an additional parameter `phone_number_2fa` which shows the signer's phone number used for authentication method `phone` or `sms`. For the event: * `document_group_authentication_success` the response may contain an additional parameter `authentication_code` which shows the code used for authentication method `sms`. The signer receives a code by SMS and enters this code to access the opened document.
**View the complete list of document group events:** | **Event name** | **Meaning** | | --- | --- | | `document_group_created` | The document group was created. | | `document_group_user_logged_in` | A user logged in during interaction with the document group. | | `document_group_viewed` | The document group was viewed. | | `document_group_approved` | The document group was approved. | | `document_group_signed` | The document group was signed. | | `document_group_sign_owner_attachment_sent` | The completed document group was sent to the owner as an attachment. | | `document_group_sign_signer_attachment_sent` | The completed document group was sent to the signer as an attachment. | | `document_group_downloaded` | The document group was downloaded. | | `document_group_invite_sent` | The document group invite was sent. | | `document_group_invite_resend` | The document group invite was resent. | | `document_group_invite_completed` | The document group invite was completed. | | `document_group_invite_cancelled` | The document group invite was cancelled. | | `document_group_invite_full_declined` | The document group invite was declined by all recipients. | | `document_group_invite_approver_full_declined` | The document group invite was declined by all approvers. | | `document_group_fieldinvite_declined` | The document group field invite was declined. | | `document_group_freeform_invite_sent` | A FreeForm invite for the document group was sent. | | `document_group_freeform_invite_resend` | A FreeForm invite for the document group was resent. | | `document_group_freeform_invite_cancelled` | A FreeForm invite for the document group was cancelled. | | `document_group_freeform_invite_signed_by_user` | A recipient signed a FreeForm invite for the document group. | | `document_group_freeform_invite_completed` | A FreeForm invite for the document group was completed. | | `document_group_freeform_sign_owner_attachment_sent` | The document group signed in a FreeForm invite was sent to the owner. | | `document_group_freeform_sign_signer_attachment_sent` | The document group signed in a FreeForm invite was sent to the signer. | | `document_group_authentication_success` | A document group signer successfully passed authentication. | | `document_group_authentication_failure` | A document group signer failed to pass authentication. | | `document_group_approver_authentication_success` | A document group approver successfully passed authentication. | | `document_group_approver_authentication_failure` | A document group approver failed to pass authentication. | | `document_group_correction_start` | A correction process started for the document group. | | `document_group_correction_finish` | A correction process finished for the document group. |
## Authorization bearer ## Path Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `document_group_id` | string | Yes | ID of the document group. | ## Header Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `Content-Type` | string | No | application/json | ## Responses ### 200 Successful response. Returns the history events of the document group, with pagination details and a summary in `meta`. For the `document_group_authentication_success` and `document_group_authentication_failure` events, `json_attributes` contains `authentication_type` and `phone_number_2fa`. The `id_address` attribute is deprecated. Use `ip_address` instead. **Example** (`without invite`) ```json { "data": [ { "email": "owner@email.com", "event": "document_group_downloaded", "created": 1590054771, "user_id": "ff294db734e38215507200f1d3dc76c526162807", "unique_id": "5a4f923de5fb2554fc2ef3a8b7697653cf6e489f", "ip_address": "00.00.00.00", "session_id": null, "client_app_name": "Sample Application", "json_attributes": null, "client_timestamp": 1586165940, "document_group_id": "be3f35eab7b07c0346eedc9fe4f04bd0d80edef4" } ], "meta": { "summary": { "created": 1625136688, "amount_of_pages": 11 }, "pagination": { "count": 1, "links": [], "total": 1, "per_page": 15, "total_pages": 1, "current_page": 1 } } } ``` **Example** (`with a group invite`) ```json { "data": [ { "email": "sender@email.com", "event": "document_group_downloaded", "created": 1590054771, "user_id": "ff294db734e38215507200f1d3dc76c526162807", "unique_id": "5a4f923de5fb2554fc2ef3a8b7697653cf6e489f", "ip_address": "142.32.0.1", "session_id": null, "client_app_name": "Sample Application", "json_attributes": null, "client_timestamp": 1586165940, "document_group_id": "be3f35eab7b07c0346eedc9fe4f04bd0d80edef4" } ], "meta": { "summary": { "sender": "sender@email.com", "created": 1625136688, "group_sent": 1622029581, "recipients": [ "recipient1@email.com", "recipient2@email.com" ], "group_status": "pending", "last_updated": 1625233888, "amount_of_pages": 11 }, "pagination": { "count": 1, "links": [], "total": 1, "per_page": 15, "total_pages": 1, "current_page": 1 } } } ``` **Example** (`document group authentication failure`) ```json { "data": [ { "email": "owner_document_group@email.com", "event": "document_group_created", "created": 1672751428, "user_id": "356649ccba2b15c14eddea110332624ae78004c7", "unique_id": "95c839c729403f5ca270b55f0b3a2dd3a6e31790", "ip_address": "00.00.00.00", "client_app_name": "Sample application", "json_attributes": null, "client_timestamp": 0, "document_group_id": "7d78249073af6aaa8eb55e0c8a4446e2330e64ea" }, { "email": "owner_document_group@email.com", "event": "document_group_invite_sent", "created": 1672751636, "user_id": "356649ccba2b15c14eddea110332624ae78004c7", "unique_id": "c47080a79f246198e4ccb9c618ed74ac633cb125", "ip_address": "00.00.00.00", "client_app_name": "Sample application", "json_attributes": { "signers": [ "signer1@email.com", "signer2@email.com" ], "viewers": [], "document_unique_ids": [ "0169d7c027e348a2e0bef03cc8ed56377492bfcc" ], "group_invite_unique_id": "8d3d035260de5e7d4300b931f77f024088e18fcd" }, "client_timestamp": 1745310494, "document_group_id": "7d78249073af6aaa8eb55e0c8a4446e2330e64ea" }, { "email": "signer1@email.com", "event": "document_group_authentication_failure", "created": 1672751775, "user_id": "6a27b7c3316c2cb8ae6ebdc2d96721b2735a2249", "unique_id": "78987dda51aa730232f06342277c32897f3d02fe", "ip_address": "00.00.00.00", "client_app_name": "Sample Application", "json_attributes": { "phone_number_2fa": "+1XXX-XXXXXXX", "authentication_type": "sms", "document_unique_ids": [ "0169d7c027e348a2e0bef03cc8ed56377492bfcc" ], "group_invite_unique_id": "8d3d035260de5e7d4300b931f77f024088e18fcd" }, "client_timestamp": 1672751775, "document_group_id": "7d78249073af6aaa8eb55e0c8a4446e2330e64ea" }, { "email": "signer2@email.com", "event": "document_group_authentication_failure", "created": 1672751811, "user_id": "83c4e7e0455617f7e4fe3db5a29a73c96349f52a", "unique_id": "0d0dbedfb5dcbca7a264a2492e251e2e861965f0", "ip_address": "00.00.00.00", "client_app_name": "Sample Application", "json_attributes": { "phone_number_2fa": "+1XXX-XXXXXXX", "authentication_type": "phone_call", "document_unique_ids": [ "0169d7c027e348a2e0bef03cc8ed56377492bfcc" ], "group_invite_unique_id": "8d3d035260de5e7d4300b931f77f024088e18fcd" }, "client_timestamp": 1672751811, "document_group_id": "7d78249073af6aaa8eb55e0c8a4446e2330e64ea" } ], "meta": { "summary": { "sender": "owner_document_group@email.com", "created": 1672751428, "cc_emails": [ "cc-recipient1@email.com", "cc-recipient2@email.com" ], "group_sent": 1672751635, "recipients": [ "signer1@email.com", "signer2@email.com" ], "group_status": "pending", "last_updated": 1672751635, "amount_of_pages": 2 } } } ``` ### 400 * Wrong, expired, or missing token. **Example** (`Wrong token`) ```json { "code": 1537, "error": "invalid_token" } ``` ### 403 The user does not have access to the document group. **Example** (`The user does not have access to the document group`) ```json { "errors": [ { "message": "Access to DocumentGroup denied" } ] } ``` ### 404 * The document group was not found. * The document group is not active. **Example** (`Document group not found`) ```json { "errors": [ { "message": "Document group `ff294db734e38215507200f1d3dc76c526162807` not found" } ] } ``` ## 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}/historyfull" \ -H "Authorization: Bearer $SIGNNOW_ACCESS_TOKEN" ``` --- *Full reference: https://docs.signnow.com/docs/document-group/operations/get-documentgroup-document-group-id-historyfull*