--- title: "Get document group history" method: GET path: "/documentgroup/{document_group_id}/historyfull" --- # Get document group history `GET /documentgroup/{document_group_id}/historyfull` ## Request - Base URL: `https://api.signnow.com` - URL: `https://api.signnow.com/documentgroup/{document_group_id}/historyfull` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) 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. |
## Response `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. - object - `data` object[]: History events of the document group. - `email` string: Email address of the user who performed the action. - `event` string: Name of the event, for example `document_group_created`. - `created` integer: Unix timestamp of the event. - `user_id` string: ID of the user who performed the action. - `unique_id` string: ID of the history event. - `id_address` string: IP address the action was performed from. Same as `ip_address`. - `ip_address` string: IP address the action was performed from. - `session_id` integer: ID of the session the action was performed in. `null` if not available. - `client_app_name` string: Name of the application the action was performed in. - `json_attributes` object: Additional details of the event. The content depends on the event. `null` if there are none. - `signers` string[]: Signers of the invite step. - `viewers` string[]: Viewers of the invite step. - `approvers` unknown[]: Approvers of the invite step. - unknown - `phone_number_2fa` string: Phone number used for two-factor authentication. Returned for phone authentication events. - `authentication_type` string: Authentication type used by the signer. Returned for authentication events. - `document_unique_ids` string[]: IDs of the documents the event relates to. - `group_invite_unique_id` string: ID of the document group invite. - `client_timestamp` integer: Unix timestamp of the action on the client side. `0` if not available. - `document_group_id` string: ID of the document group. - `signer_phone_invite` string: Phone number of the signer for SMS invites. `null` for email invites. - `meta` object: Pagination details and a summary of the document group. - `summary` object: Summary of the document group. - `sender` string: Email address of the sender. - `created` integer: Unix timestamp of when the document group was created. - `signers` object[]: Signers of the document group invite. - `email` string: Email address of the signer. - `last_name` string: Last name of the signer. - `first_name` string: First name of the signer. - `cc_emails` string[]: Email addresses of CC recipients. - `group_sent` integer: Unix timestamp of when the document group invite was sent. - `recipients` string[]: Recipients of the document group invite. - `group_status` string: Status of the document group invite, for example `pending`. - `last_updated` integer: Unix timestamp of the last update of the document group. - `amount_of_pages` integer: Total number of pages in the document group. - `pagination` object: Pagination details. - `count` integer: Number of items on the current page. - `links` object: Links to the adjacent pages. An empty array if there are no other pages. - `next` string: URL of the next page. Returned only if there is a next page. - `previous` string: URL of the previous page. Returned only if there is a previous page. - `total` integer: Total number of items. - `per_page` integer: Maximum number of items per page. - `total_pages` integer: Total number of pages. - `current_page` integer: Number of the current page. ## Other responses - `400`: * Wrong, expired, or missing token. - `403`: The user does not have access to the document group. - `404`: * The document group was not found. * The document group is not active. --- [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)