Envelope Templates

Gets templates used in an envelope

GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates

This returns a list of the server-side templates, their name and ID, used in an envelope.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

envelopeId*string

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Query Parameters

include?string

Filters the results by template type. Valid values:

  • applied: Returns the templates applied to an envelope.
  • matching: Returns the matching templates for an envelope.

The default value is applied.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/envelopes/string/templates"
{  "templates": [    {      "applied": "string",      "documentId": "string",      "documentName": "string",      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "name": "string",      "templateId": "string",      "templateMatch": {        "documentEndPage": "string",        "documentStartPage": "string",        "matchPercentage": "string"      },      "uri": "string"    }  ]}