--- title: "Get list of documents from template" method: GET path: "/v2/templates/{template_id}/copies" --- # Get list of documents from template `GET /v2/templates/{template_id}/copies` ## Request - Base URL: `https://api.signnow.com` - URL: `https://api.signnow.com/v2/templates/{template_id}/copies` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) This endpoint allows API users to retrieve all documents created from a template. **Example of a request with query parameters** ```json /v2/templates/{template_id}/copies?sort_by=created&sort_order=desc&per_page=20&filters[signing_status]=pending` ``` ## Response `200` Successful response. Returns the documents created from the template, with pagination details. Use the query parameters to filter, sort, and paginate the results. - object - `data` object[]: Documents created from the template. - `id` string: The ID of the document in the Document table - `owner` string: Email address of the document owner. - `roles` object[]: List of signer roles defined for the document. - `name` string: Name of the role, for example `Signer 1`. - `unique_id` string: ID of the role. - `signing_order` integer: Position of the role in the signing order. - `seals` unknown[]: List of applied seal elements on the document. - unknown - `texts` unknown[]: List of text elements added to the document. - unknown - `checks` unknown[]: List of checkmark elements added to the document. - unknown - `fields` object[]: List of fillable fields defined on the document. - `id` string: ID of the field. - `role` string: Name of the role the field is assigned to. - `type` string: Field type, for example `text`, `signature`, or `checkbox`. - `role_id` string: ID of the role the field is assigned to. - `field_id` string: ID of the field. - `fulfiller` string: Email address of the recipient who filled in the field. `null` if not filled in. - `element_id` string: ID of the element that holds the field value. `null` if the field is empty. - `originator` string: Email address of the document 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` integer: Font size in the SignNow editor scale. - `align` string: Horizontal text alignment: `left`, `center`, or `right`. - `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. - `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` string: Vertical text alignment: `top`, `middle`, or `bottom`. - `required` boolean: `true` if the recipient must fill in the field. - `font_size` integer: Font size on the document page, in PDF points. - `max_chars` integer: Maximum number of characters the recipient can enter. `0` means no limit. - `max_lines` integer: Maximum number of lines the recipient can enter. `0` means no limit. - `underline` boolean: `true` if the text is underlined. - `arrangement` string: How the text is laid out in the field, for example `none`. - `page_number` integer: Zero-based number of the page the field is on. - `stretch_mode` string: How the field resizes to fit its content, for example `fixed`. - `validator_id` string: ID of the validator applied to the field. - `allowed_types` string[]: For signature fields: the ways the recipient can add a signature, for example `type` or `draw`. - `prefilled_text` string: Prefilled value of the field. `null` if not set. - `lock_to_sign_date` boolean: For date fields: `true` if the field is filled with the signing date and cannot be changed. - `prefill_content_type` string: Type of the prefilled content. `null` if the field is not prefilled. - `field_request_id` string: ID of the field request. Use it to resend the invite with `PUT /fieldinvite/{field_request_id}/resend`. - `template_field_id` string: ID of the corresponding field in the source template. `null` if the document was not created from a template. - `field_request_canceled` boolean: `"1"` if the field request was canceled. `null` otherwise. - `created` integer: Unix timestamp when the document was created. - `inserts` unknown[]: List of text inserts added to the document. - unknown - `updated` integer: Unix timestamp of the last document update. - `user_id` string: The ID of the user - `requests` object[]: List of document requests. - `settings` object: Document-level settings and feature flags. - `parent_id` string: Identifier of the parent document. - `thumbnail` object: Links to the document thumbnail images in `small`, `medium`, and `large` sizes. - `large` string: URL of the large thumbnail. - `small` string: URL of the small thumbnail. - `medium` string: URL of the medium thumbnail. - `page_count` integer: Number of pages in the document. - `signatures` object[]: List of applied signature elements on the document. - `attachments` object[]: List of file attachments on the document. - `x` integer: Horizontal position of the attachment field on the page, in pixels. - `y` integer: Vertical position of the attachment field on the page, in pixels. - `id` string: ID of the attachment field. - `width` integer: Width of the attachment field, in pixels. - `height` integer: Height of the attachment field, in pixels. - `created` integer: Unix timestamp of when the attachment was added. - `user_id` string: ID of the user who added the attachment. - `filename` string: Name under which the attached file is stored. - `file_size` integer: Size of the attached file, in bytes. - `file_type` integer: Type of the attached file. - `mime_type` string: MIME type of the attached file, for example `jpeg`. - `line_height` string: Line height of the attachment field, in pixels. - `page_number` integer: Zero-based number of the page the attachment field is on. - `json_attributes` string: Additional attributes of the attachment field. `null` if none. - `original_attachment_name` string: Original name of the attached file. - `radiobuttons` unknown[]: List of radio button groups on the document. - unknown - `viewer_roles` object[]: List of viewer roles defined for the document. - `document_name` string: The name of the document - `entity_labels` unknown[]: Labels assigned to the document, for example when an invite email could not be delivered. Empty if there are none. - unknown - `field_invites` object[]: List of signer field invites for the document. - `id` string: ID of the field invite. - `role` string: Name of the recipient role. - `email` string: Email address of the signer. For an SMS invite, a generated placeholder address. - `status` string: Status of the invite, for example `pending`, `fulfilled`, or `declined`. - `created` integer: Unix timestamp of when the invite was created. - `role_id` string: ID of the recipient role. - `updated` integer: Unix timestamp of the last update of the invite. - `declined` object[]: Decline details. Empty if the signer has not declined. - `reassign` boolean: `"1"` if the signer can reassign the invite, otherwise `"0"`. - `reminder` boolean: `"1"` if reminders are enabled for the invite, otherwise `"0"`. - `compliance` object: Compliance settings of the invite. - `cfr` string: 21 CFR Part 11 settings of the invite. `null` if not applied. - `id_verified` string: ID verification status of the signer, for example `UNVERIFIED`. - `is_embedded` boolean: `true` if the invite is an embedded invite. - `delivery_type` string: How the invite is delivered: `email` or `sms`. - `password_type` string: Type of the invite password. Empty if no password is set. - `signature_type` string: Type of signature required from the signer. `null` if not set. - `signer_user_id` string: ID of the signer user. - `expiration_time` integer: Unix timestamp of when the invite expires. - `is_draft_exists` boolean: `"1"` if the signer has saved a draft, otherwise `"0"`. - `password_method` string: Method used to deliver the invite password. Empty if no password is set. - `payment_request` object: Payment request attached to the invite. `null` if there is none. - `is_full_declined` boolean: `true` if the recipient declined the invite. - `sms_sent_statuses` unknown[]: SMS delivery events of the invite. Empty for email invites. - unknown - `is_document_locked` boolean: `"1"` if the document is locked for this signer, otherwise `"0"`. - `password_protected` boolean: `"1"` if the invite is password-protected, otherwise `"0"`. - `email_sent_statuses` object[]: Email delivery events of the invite. Each object is one event. - `status` string: Email delivery status, for example `sent` or `delivered`. - `created_at` integer: Unix timestamp of when the event was recorded. - `last_reaction_at` integer: Unix timestamp of the last update of the event. - `force_new_signature` boolean: `1` if the signer must create a new signature instead of reusing a saved one. `null` if not set. - `signer_phone_invite` string: Phone number the SMS invite was sent to. `null` for email invites. - `decline_by_signature` string: `"1"` if the signer can decline the invite, otherwise `"0"`. `null` if not set. - `signing_instructions` boolean: Instructions shown to the signer. `null` if not set. - `electronic_consent_id` string: ID of the electronic consent the signer accepted. `null` if not accepted. - `prefill_signature_name` boolean: Name prefilled in the signature field. `null` if not set. - `id_verification_required` string: Whether ID verification is required, for example `NO`. - `electronic_consent_required` integer: `1` if the signer must accept the electronic consent before signing, otherwise `0`. - `required_preset_signature_name` boolean: Name the signer must use in the signature. `null` if not set. - `recently_used` integer: Unix timestamp of the last time the document was used. - `approver_roles` unknown[]: List of approver roles defined for the document. - unknown - `notary_invites` unknown[]: List of notary invites on the document. - unknown - `origin_user_id` string: Identifier of the user who owns the source document. Can be `null`. - `routing_details` object[]: Invite routing configuration, including signer order, `cc` recipients, and invite link instructions. - `cc` object[]: Email addresses that receive a copy of the completed document. - `id` string: ID of the routing details. - `data` object[]: Signer roles and their invite settings. - `name` string: Name of the role. - `role_id` string: ID of the role. - `reassign` boolean: `true` if the recipient can reassign the invite. - `reminder` object: Reminder settings of the invite. - `remind_after` integer: Number of days after the invite is sent before the first reminder. - `remind_before` integer: Number of days before expiration to send a reminder. - `remind_repeat` integer: Number of days between repeated reminders. - `attributes` object: Additional attributes of the role. - `inviter_role` boolean: `true` if the document owner is the recipient for this role. - `phone_invite` string: Phone number for an SMS invite. `null` for email invites. - `default_email` string: Default email address of the recipient for this role. Empty if not set. - `delivery_type` string: How the invite is delivered: `email` or `sms`. - `signing_order` integer: Position of the role in the signing order. - `expiration_days` integer: Number of days before the invite expires. - `decline_by_signature` boolean: `true` if the recipient can decline to sign. - `cc_step` object[]: Steps after which CC recipients are notified. - `created` integer: Unix timestamp of when the routing details were created. - `updated` integer: Unix timestamp of the last update of the routing details. - `viewers` object[]: Viewer roles and their invite settings. Empty if there are no viewers. - `approvers` unknown[]: Approver roles and their invite settings. Empty if there are no approvers. - unknown - `invite_link_instructions` string: Instructions shown with the invite link. Empty if not set. - `field_validators` object[]: List of field validation rules. - `id` string: ID of the validator. - `name` string: Name of the validator. - `scope` string: Scope of the validator. `system` for built-in validators. - `description` string: Description of the expected value. - `error_message` string: Message shown when the value does not match. - `regex_expression` string: Regular expression the value must match. - `display_json_attributes` object: Display settings of the validator in the SignNow web app. - `common` boolean: `true` if the validator is in the common list. - `disabled` boolean: `true` if the validator is disabled. - `web_locale_key` string: Localization key of the validator. - `web_short_name` string: Short name shown in the web app. - `web_description` string: Description shown in the web app. - `text_field_order` integer: Position of the validator in the text list. `null` if it is not in the list. - `date_time_field_order` integer: Position of the validator in the date and time list. - `original_filename` string: Original filename of the uploaded document. - `origin_document_id` string: Identifier of the source document if this document was created as a copy. Can be `null`. - `document_group_info` object: Document group information if this document belongs to a group. - `invite_id` string: ID of the document group invite. `null` if no invite has been sent. - `invite_status` string: Status of the document group invite. `null` if no invite has been sent. - `document_group_id` string: ID of the document group. `null` if the document is not in a group. - `document_group_name` string: Name of the document group. `null` if the document is not in a group. - `enumeration_options` object[]: List of enumeration options for dropdown fields. - `viewer_field_invites` object[]: List of viewer field invites for the document. - `approver_field_invites` unknown[]: List of approver field invites for the document. - unknown - `meta` object: Pagination details. - `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. * Request with incorrect {template_id}. * Request with {template_id} where the user is not owner of the template. * Wrong sort_by format, incorrect value. * Wrong sort_order format, incorrect value. * Wrong per_page format, incorrect value. * Wrong page format, incorrect value. * Wrong filters[signing_status] format, incorrect value. --- [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)