EnvelopeTemplates: listByDocument

Retrieves the templates associated with a document in the specified envelope.

Request

HTTP request

GET /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates

Parameters

Parameter name Value Description
Path parameters
accountId string

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

documentId string

The ID of the document being accessed.

envelopeId string

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

Optional query parameters
include string

A comma-separated list that limits the results. Valid values:

  • applied
  • matched

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Envelopes::listTemplatesForDocument

Definitions Expand All | Collapse All

EnvelopeTemplates

Envelope templates

templates
[templateSummary]

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

templateMatch

documentEndPage string
documentStartPage string
matchPercentage string

templateSummary

applied string

Reserved: TBD

documentId string

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

documentName string
name string
templateId string

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

templateMatch templateMatch
uri string

Examples

Generic JSON Response

Response

{
"templates": [
{
"templateId": "sample string 1",
"name": "sample string 2",
"documentId": "sample string 3",
"documentName": "sample string 4",
"applied": "sample string 5",
"templateMatch": {
"matchPercentage": "sample string 1",
"documentStartPage": "sample string 2",
"documentEndPage": "sample string 3"
}
,
"uri": "sample string 6"
}
]
}

Generic XML Response

Response

<templateInformation 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<templates>
<templateSummary>
<applied>sample string 5</applied>
<documentId>sample string 3</documentId>
<documentName>sample string 4</documentName>
<name>sample string 2</name>
<templateId>sample string 1</templateId>
<templateMatch>
<documentEndPage>sample string 3</documentEndPage>
<documentStartPage>sample string 2</documentStartPage>
<matchPercentage>sample string 1</matchPercentage>
</templateMatch>
<uri>sample string 6</uri>
</templateSummary>
</templates>
</templateInformation>