Skip to content

DocuSign: Gets the status of a single envelope

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

← Esignature operations · Get started

Operation docusign.esignature_envelopes_getenvelope

Provider route: GET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}. 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"]["esignatureEnvelopesGetEnvelope"]>[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.esignatureEnvelopesGetEnvelope(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_envelopes_get_envelope(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.advanced_updatestringOptional
query.includestringOptional
query.include_anchor_tab_locationsstringOptional
query.user_idstringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets the status of a single envelope — response body

Referenced models: Gets the status of a single envelope — response body

144 more schemas are linked from the tables above, on the schema pages.

Gets a list of custom fields — response body
FieldTypePresenceDescription and constraints
$objectRootAn `accountCustomField` is an envelope custom field that you set at the account level.
Applying custom fields enables account administrators to group and manage envelopes.
listCustomFieldsarrayOptionalAn array of list custom fields.
listCustomFields[]ModelEach itemExpand Gets a list of custom fields — response body — list Custom Fields item
textCustomFieldsarrayOptionalAn array of text custom fields.
textCustomFields[]ModelEach itemExpand Gets a list of custom fields — response body — text Custom Fields item

Referenced models: Gets a list of custom fields — response body — list Custom Fields item, Gets a list of custom fields — response body — text Custom Fields item

Locks an envelope — response body
FieldTypePresenceDescription and constraints
$objectRootEnvelope locks let you lock an envelope to prevent any changes while you are updating an envelope.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
lockDurationInSecondsstringOptional
The number of seconds until the lock expires when there is no activity on the envelope.

The default value is 300 seconds. The maximum value is 1,800 seconds.

The lock duration can be extended.
lockTokenstringOptionalA unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock.
lockTypestringOptionalThe type of lock. Currently `edit` is the only supported type.
lockedByAppstringOptionalThe human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur.
lockedByUserModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
A complex type containing information about the user that has the envelope or template locked.
lockedUntilDateTimestringOptionalThe date and time that the lock expires.
useScratchPadstringOptionalWhen **true,** a scratchpad is used to edit information.

Referenced models: Locks a template — response body — error Details, Gets a specific template associated with a specified account — response body — owner

Deletes recipients from an envelope — response body
FieldTypePresenceDescription and constraints
$objectRootEnvelope recipients
agentsarrayOptionalA list of agent recipients assigned to the documents.
agents[]ModelEach itemExpand Deletes recipients from a template — response body — agents item
authorizedSignatoriesarrayOptional
authorizedSignatories[]ModelEach itemExpand Deletes recipients from a template — response body — authorized Signatories item
carbonCopiesarrayOptionalA list of carbon copy recipients assigned to the documents.
carbonCopies[]ModelEach itemExpand Deletes recipients from a template — response body — carbon Copies item
certifiedDeliveriesarrayOptionalA complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.
certifiedDeliveries[]ModelEach itemExpand Deletes recipients from a template — response body — certified Deliveries item
currentRoutingOrderstringOptionalThe routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions.
editorsarrayOptionalA list of users who can edit the envelope.
editors[]ModelEach itemExpand Deletes recipients from a template — response body — editors item
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
inPersonSignersarrayOptionalSpecifies a signer that is in the same physical location as a Docusign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.
inPersonSigners[]ModelEach itemExpand Deletes recipients from a template — response body — in Person Signers item
intermediariesarrayOptionalIdentifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).
intermediaries[]ModelEach itemExpand Deletes recipients from a template — response body — intermediaries item
notariesarrayOptionalA list of notary recipients on the envelope.
notaries[]ModelEach itemExpand Deletes recipients from a template — response body — notaries item
notaryWitnessesarrayOptional
notaryWitnesses[]ModelEach itemExpand Deletes recipients from a template — response body — notary Witnesses item
participantsarrayOptional
participants[]ModelEach itemExpand Deletes recipients from a template — response body — participants item
recipientCountstringOptionalThe number of recipients in the envelope.
sealsarrayOptionalA list of electronic seals to apply to documents.
seals[]ModelEach itemExpand Deletes recipients from a template — response body — seals item
signersarrayOptionalA list of signers on the envelope.
signers[]ModelEach itemExpand Deletes recipients from a template — response body — signers item
witnessesarrayOptionalA list of signers who act as witnesses on the envelope.
witnesses[]ModelEach itemExpand Deletes recipients from a template — response body — witnesses item

Referenced models: Deletes recipients from a template — response body — agents item, Deletes recipients from a template — response body — authorized Signatories item, Deletes recipients from a template — response body — carbon Copies item, Deletes recipients from a template — response body — certified Deliveries item, Deletes recipients from a template — response body — editors item, Locks a template — response body — error Details, Deletes recipients from a template — response body — in Person Signers item, Deletes recipients from a template — response body — intermediaries item, Deletes recipients from a template — response body — notaries item, Deletes recipients from a template — response body — notary Witnesses item, Deletes recipients from a template — response body — participants item, Deletes recipients from a template — response body — seals item, Deletes recipients from a template — response body — signers item, Deletes recipients from a template — response body — witnesses item

Updates an envelope attachment in a draft or in-process envelope — request body — body
FieldTypePresenceDescription and constraints
$objectRootContains information about an attachment.
accessControlstringOptionalValid values are `sender` and `senderAndAllRecipients`.
attachmentIdstringOptionalThe unique identifier for the attachment.
attachmentTypestringOptionalSpecifies the type of the attachment for the recipient.
datastringOptionalA Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.
labelstringOptionalA label for the attachment. Potential values include:

- `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms.
- `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property.
namestringOptionalThe name of the attachment.
remoteUrlstringOptionalThe URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads.

SDK function policy ID: docusign.esignature_envelopes_getenvelope. Catalog operation: esignature:Envelopes_GetEnvelope. 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.