--- title: "Get doc group template info" method: GET path: "/v2/document-group-templates/{document_group_template_id}" --- # Get doc group template info `GET /v2/document-group-templates/{document_group_template_id}` ## Request - Base URL: `https://api.signnow.com` - URL: `https://api.signnow.com/v2/document-group-templates/{document_group_template_id}` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) 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}`](/docs/document/operations/get-document). 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}`](/docs/document/operations/get-document) 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`](/docs/document-group-template/operations/get-v2-document-group-templates-doc-group-template-id-recipients). * To add or update fields, call [`PUT /document/{document_id}`](/docs/document/operations/edit-document) 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}`](/docs/document-group/operations/get-document-group-info-v2). ## Response `200` - Request with correct token - Request with `include=documents.fields` - object - `data` object: Information about the document group template. - `id` string: Unique identifier of the document group template. - `name` string: Name of the document group template. - `owner` object: Owner of the document group template. - `id` string: Unique identifier of the owner. - `email` string: Email address of the owner. - `created` integer: Unix timestamp (seconds) when the document group template was created. - `updated` integer: Unix timestamp (seconds) of the last update to the document group template. - `documents` object[]: Active documents in the template, in template order. - `id` string: Unique identifier of the document. Can change when the template is converted, so don't store it as a permanent key. - `roles` object[]: Active roles assigned to the document. An empty array if the document has no roles. - `name` string: Name of the role, for example `Signer 1`. - `fields` object[]: Fields in the document. Returned only with `?include=documents.fields`. An empty array if the document has no fields. Each object has the same format as an item of the `fields` array returned by [`GET /document/{document_id}`](/docs/document/operations/get-document). Fields are listed by type in this order: `text`, `signature`, `checkbox`, `initials`, `enumeration`, `attachment`, `radiobutton`, `hyperlink`, `stamp`. - `id` string: Unique identifier of the field. - `role` string: Name of the role the field is assigned to. - `type` 'text' | 'signature' | 'checkbox' | 'initials' | 'enumeration' | 'attachment' | 'radiobutton' | 'hyperlink' | 'stamp': Field type. - `radio` object[]: For `radiobutton` fields only: the buttons in the radio group. - `x` integer: Horizontal position of the button, in pixels. - `y` integer: Vertical position of the button, in pixels. - `value` string: Value of the button. - `width` integer: Width of the button, in pixels. - `height` integer: Height of the button, in pixels. - `checked` integer: `1` if the button is selected, `0` otherwise. - `created` integer: Unix timestamp when the button was created. - `radio_id` string: Unique identifier of the radio button. - `page_number` integer: Zero-based number of the page the button is on. - `json_attributes` unknown[]: Additional button attributes. Empty array if none. - unknown - `role_id` string: Unique identifier of the role the field is assigned to. Role IDs are unique per document: a role with the same name has a different `role_id` in each document of the template. To match roles across documents, use `role`. - `field_id` string: Always `null` for a document group template field. Kept for compatibility with `GET /document/{document_id}`. - `fulfiller` string: Always `null` for a document group template field. Kept for compatibility with `GET /document/{document_id}`. - `element_id` string: Always `null` for a document group template field. Kept for compatibility with `GET /document/{document_id}`. - `originator` string: Email address of the document group template owner. - `json_attributes` object: Position, size, and settings of the field. The set of keys depends on the field type. - `x` integer: Horizontal position of the field on the page, in pixels. - `y` integer: Vertical position of the field on the page, in pixels. - `bold` boolean: `true` if the text is bold. - `font` string: Font name, for example `Arial`. - `name` string: Name of the field. - `size` number: Font size in the SignNow editor scale, where the page is rendered `890` pixels wide. From `8` to `72`. - `align` 'left' | 'center' | 'right': Horizontal text alignment. - `color` string: Text color as a 6-character hex code without `#`, for example `000000`. - `label` string: Label of the field shown to the recipient. Returned only if a label is set. - `value` string: For `checkbox` fields: the checkbox label. - `width` integer: Width of the field, in pixels. - `height` integer: Height of the field, in pixels. - `italic` boolean: `true` if the text is italic. - `valign` 'top' | 'middle' | 'bottom': Vertical text alignment. - `required` boolean: `true` if the recipient must fill in the field. - `font_size` number: Font size on the document page, in PDF points. The same size as `size`, converted to the page scale. - `max_chars` integer: Maximum number of characters the recipient can enter. From `0` to `999`; `0` means no limit. - `max_lines` integer: Maximum number of lines the recipient can enter. From `0` to `99`; `0` means no limit. - `underline` boolean: `true` if the text is underlined. - `arrangement` 'none' | 'cells': How the text is laid out in the field. `none`: regular text. `cells`: one character per cell; `max_lines` is then `1`. - `page_number` integer: Zero-based number of the page the field is on. - `allowed_types` string[]: For `signature` fields: the ways the recipient can add a signature. Possible values: `type`, `draw`, `upload`. - `prefilled_text` string: Default value of the field, set in the template. For `text` fields: the default text, returned only if set. For `checkbox` fields: `"0"` if the checkbox is not checked by default. - `custom_defined_option` string: For `enumeration` (dropdown) fields: whether the recipient can enter their own value instead of choosing a listed option. An empty string or `false` means they can't. - `field_request_id` string: Always `null` for a document group template field. Kept for compatibility with `GET /document/{document_id}`. - `template_field_id` string: Always `null` for a document group template field. Kept for compatibility with `GET /document/{document_id}`. - `field_request_canceled` string: Always `null` for a document group template field. Kept for compatibility with `GET /document/{document_id}`. - `document_name` string: Name of the document. ## Other responses - `400`: - Request with incorrect or missing token. - `404`: - Document group template ID does not exist. - Document group template is not active. - User has no access to the document group template. --- [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)