SIsignnow

Get document group

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.

get/documentgroup/{document_group_id}

Request

Path parameters

ID of the document group.

Response

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.

idstring

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.

folder_idstring

Unique identifier of the folder that contains the document group, or null if the group is not in a folder.

invite_idstring

Unique identifier of the active group invite, or null if no invite has been created.

group_namestring

Display name of the document group.

mail_providerunknown
scheduled_inviteunknown
email_action_on_completeunknown

Changes

No recorded changes to this operation across all 1 revision of this API.