Skip to content

DocuSign: Gets templates used in an envelope

DocuSign esignature.esignatureTemplatesGetEnvelopeTemplates: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_templates_getenvelopetemplates

Provider route: GET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureTemplatesGetEnvelopeTemplates"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureTemplatesGetEnvelopeTemplates(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_templates_get_envelope_templates(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
path.envelopeIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.includestringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets templates used in an envelope — response body

Referenced models: Gets templates used in an envelope — response body

Gets templates used in an envelope — response body
FieldTypePresenceDescription and constraints
$objectRoot
templatesarrayOptionalAn array of `templateSummary` objects that contain information about templates.
templates[]ModelEach itemExpand Creates one or more templates — response body

Referenced models: Creates one or more templates — response body

Creates one or more templates — response body
FieldTypePresenceDescription and constraints
$objectRootSummary of a template request.
appliedstringOptionalReserved for Docusign.
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing document's ID attribute.
documentNamestringOptionalThe name of the document.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
namestringOptionalThe name of the template.
templateIdstringOptionalThe unique identifier of the template. If this is not provided, Docusign will generate a value.
templateMatchModelOptionalExpand Creates one or more templates — response body — template Match
uristringOptionalA URI containing the user ID.

Referenced models: Locks a template — response body — error Details, Creates one or more templates — response body — template Match

Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.
Creates one or more templates — response body — template Match
FieldTypePresenceDescription and constraints
$objectRoot
documentEndPagestringOptional
documentStartPagestringOptional
matchPercentagestringOptional

SDK function policy ID: docusign.esignature_templates_getenvelopetemplates. Catalog operation: esignature:Templates_GetEnvelopeTemplates. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.