Skip to navigation

Get templates associated with document in envelope

View as Markdown
Retrieves the templates associated with a document in the specified envelope.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

documentIdstringRequired

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647).

Tab objects have a documentId property that specifies the document on which to place the tab.

envelopeIdstringRequired

The envelope’s GUID.

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

Query parameters

includestringOptional

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

  • applied
  • matched

Response

Successful response.
templateslist of objectsOptional

An array of templateSummary objects that contain information about templates.

Errors

400
Bad Request Error