Get doc group template info

This endpoint allows API users to retrieve information about a specific document group template, including its documents, the roles assigned to each document, and, optionally, the fields in each document.

Available to the document group template owner and to users the template is shared with.

Notes

  • Use the include query parameter to add optional data to the response. Unknown values are ignored.
  • With ?include=documents.fields, each item in documents contains a fields array. Without it, the response doesn't include fields.
  • The objects in fields have the same format as the fields array of GET /document/{document_id}. Template fields don't contain a data key. Default values set in the template, such as prefilled_text for text fields, are returned inside json_attributes.
  • 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.
  • roles contains role names only. To get the signing order and other recipient settings, call GET /v2/document-group-templates/{document_group_template_id}/recipients.
  • To add or update fields, call PUT /document/{document_id} for each document.
  • To work with a document in the template, call this endpoint to get the current document IDs right before you use them.
  • For document groups, use GET /v2/document-groups/{document_group_id}.
get/v2/document-group-templates/{document_group_template_id}

Request

Path parameters

ID of the document group template.

Query parameters

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

Response

  • Request with correct token
  • Request with include=documents.fields

Changes

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