SIsignnow

Get list of documents from template

This endpoint allows API users to retrieve all documents created from a template.

Example of a request with query parameters


/v2/templates/{template_id}/copies?sort_by=created&sort_order=desc&per_page=20&filters[signing_status]=pending`
get/v2/templates/{template_id}/copies

Request

Path parameters

The ID of the template.

Query parameters

Field to sort documents by. Possible values: updated, created, document_name.

Sort the list in ascending or descending order. Possible values: asc, desc.

Page number to view.

Number of documents per page.

Signing status to filter documents by. Possible values: waiting-for-me, waiting-for-others, signed, pending, has-invites, expired.

Label to filter documents by. Possible values: declined (the invite was declined), undelivered (the invite email wasn't delivered). You can use both values together.

Search by a key word, part of word, or phrase.

Field to search by. Possible values: document-name, signer-email, inviter-email, document-text, document-id.

Entities to exclude from the response. Possible value: doc-from-dg (documents that are in document groups).

Headers

application/json

Response

Successful response. Returns the documents created from the template, with pagination details. Use the query parameters to filter, sort, and paginate the results.

Changes

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