SIsignnow

Get document group info (v.2)

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} 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} 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} for each document.
get/v2/document-groups/{document_group_id}

Request

Path parameters

ID of the document group.

Query parameters

If used, the response will contain document group attributes.

If used, the response includes general_expiration_time, general_expiration_days, and general_reminder — defaults applied to all recipients in the invite.

If used, each item in documents contains a fields array with the fields of that document.

If used, each item in documents contains a freeform_invites array with the FreeForm invites sent for that document.

If used, each item in documents contains a signatures array with the signatures added to that document.

If used, the response contains entity_labels: the labels assigned to the document group.

If used, the response contains origin_dgt: the document group template the document group was created from.

If used, the response contains recently_used: the Unix timestamp of the last activity on the document group.

Response

Successful response. Returns the document group with its documents, invites, and owner. To also return document fields, signatures, labels, the source template, or the last activity time, use the include query parameter.

Changes

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