Retrieves a list of documents associated with the specified template.

Request

HTTP request

GET /v2/accounts/{accountId}/templates/{templateId}/documents

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID Guid.

templateIdstring

The ID of the template being accessed.

Responses

CodeDescriptionReference
200

Successful response.

TemplateDocuments
400

Error encountered.

errorDetails

SDK Method

Templates::listDocuments

Definitions

envelopeDocument

attachmentTabIdstring

authoritativeCopystring

Specifies whether all documents in this envelope are authoritative copies. A document can set its own authoritativeCopy property to override this value. For example you can set the authoritativeCopy on an envelope level to true but can turn it off for a specific document.

availableDocumentTypes[signatureType]

containsPdfFormFieldsstring

displaystring

This string sets the display and behavior properties of the document during signing. The possible values are:

  • modal
    The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. This is the recommended value for supplemental documents.

  • download
    The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a new browser window.

  • inline
    The document is shown in the normal signing window. This value is not used with supplemental documents, but is the default value for all other documents.

documentFields[nameValue]

documentGroupstring

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

includeInDownloadstring

When set to true, the document is included in the combined document download. The default value is true.

namestring

orderstring

An optional value that sets the direction order used to sort the item list.

Valid values are:

  • asc = ascending sort order
  • desc = descending sort order

pagesstring

signerMustAcknowledgestring

Sets how the signer interacts with the supplemental document. The possible values are:

  • no_interaction
    No recipient action is required.

  • view
    The recipient is required to view the document.

  • accept
    The recipient is required to accept the document by selecting accept during signing, but is not required to view the document.

  • view_accept
    The recipient is required to view and accept the document.

typestring

Type of the user. Valid values: type_owner, type_participant.

uristring

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

An error code associated with the error.

messagestring

A short error message.

nameValue

errorDetailserrorDetails

namestring

The name or key of a name/value pair.

originalValuestring

The initial value of the tab when it was sent to the recipient.

valuestring

The value field of a name/value pair.

signatureType

isDefaultstring

typestring

Type of the user. Valid values: type_owner, type_participant.

TemplateDocuments

Template documents

templateDocuments[envelopeDocument]

templateIdstring

The unique identifier of the template. If this is not provided, DocuSign will generate a value.

Examples

Generic JSON Response

Response
{
  "templateId": "sample string 1",
  "templateDocuments": [
    {
      "documentId": "sample string 1",
      "name": "sample string 2",
      "type": "sample string 3",
      "uri": "sample string 4",
      "order": "sample string 5",
      "pages": "sample string 6",
      "containsPdfFormFields": "sample string 7",
      "documentFields": [
        {}
      ],
      "availableDocumentTypes": [
        {
          "type": "sample string 1",
          "isDefault": "sample string 2"
        }
      ],
      "attachmentTabId": "sample string 8",
      "display": "sample string 9",
      "includeInDownload": "sample string 10",
      "signerMustAcknowledge": "sample string 11",
      "documentGroup": "sample string 12",
      "authoritativeCopy": "sample string 13",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      }
    }
  ]
}
Generic XML Response

Response
<templateDocumentsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <templateDocuments>
    <envelopeDocument>
      <attachmentTabId>sample string 8</attachmentTabId>
      <authoritativeCopy>sample string 13</authoritativeCopy>
      <availableDocumentTypes>
        <signatureType>
          <isDefault>sample string 2</isDefault>
          <type>sample string 1</type>
        </signatureType>
      </availableDocumentTypes>
      <containsPdfFormFields>sample string 7</containsPdfFormFields>
      <display>sample string 9</display>
      <documentFields>
        <nameValue />
      </documentFields>
      <documentGroup>sample string 12</documentGroup>
      <documentId>sample string 1</documentId>
      <errorDetails>
        <errorCode>sample string 1</errorCode>
        <message>sample string 2</message>
      </errorDetails>
      <includeInDownload>sample string 10</includeInDownload>
      <name>sample string 2</name>
      <order>sample string 5</order>
      <pages>sample string 6</pages>
      <signerMustAcknowledge>sample string 11</signerMustAcknowledge>
      <type>sample string 3</type>
      <uri>sample string 4</uri>
    </envelopeDocument>
  </templateDocuments>
  <templateId>sample string 1</templateId>
</templateDocumentsResult> 
}} />