Skip to content

DocuSign: Gets the status of recipients for an envelope

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

← Esignature operations · Get started

Operation docusign.esignature_recipients_getrecipients

Provider route: GET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients. 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"]["esignatureRecipientsGetRecipients"]>[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.esignatureRecipientsGetRecipients(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_recipients_get_recipients(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.include_anchor_tab_locationsstringOptional
query.include_extendedstringOptional
query.include_metadatastringOptional
query.include_tabsstringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Deletes recipients from an envelope — response body

Referenced models: Deletes recipients from an envelope — response body

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

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

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.
Deletes recipients from a template — response body — agents item consent Details List item
FieldTypePresenceDescription and constraints
$objectRoot
consentKeystringOptional
deliveryMethodstringOptionalThe delivery method. One of:

- `email`
- `fax`
- `SMS`
- `WhatsApp`
- `offline`

The `SMS` and `WhatsApp` delivery methods
are limited to `signer`, `carbonCopy`, and `certifiedDelivery`
recipients.

**Related topics**

- [Using SMS delivery with the eSignature API][smsconcept]
- [How to request a signature by SMS or WhatsApp delivery][howto]

[smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/
[howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/
signerConsentStatusstringOptional
Updates document visibility for recipients — response body — document Visibility item
FieldTypePresenceDescription and constraints
$objectRootThis object configures a recipient's read/write access to a document.
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
recipientIdstringOptionalThe ID of the recipient to whom the document visibility setting is applied. This value should match the `recipientId` defined in the recipient object.
rightsstringOptionalIndicates whether the document is editable:

- `editable`
- `read_only`
visiblestringOptionalWhen **true,** the document is visible to the recipient.

Referenced models: Locks a template — response body — error Details

Deletes recipients from a template — response body — seals item recipient Feature Metadata item
FieldTypePresenceDescription and constraints
$objectRoot
availabiltystringOptional
featureNamestringOptional
Updates a template document — response body — name Metadata
FieldTypePresenceDescription and constraints
$objectRootMetadata about a property.
optionsarrayOptionalAn array of option strings supported by this setting.
options[]stringEach item
rightsstringOptionalIndicates whether the property is editable. Valid values are:

- `editable`
- `read_only`
Deletes recipients from a template — response body — seals item recipient Attachments item
FieldTypePresenceDescription and constraints
$objectRoot
attachmentIdstringOptionalThe unique identifier for the attachment.
attachmentTypestringOptionalSpecifies the type of the attachment for the recipient. Possible values are:

- `.htm`
- `.xml`
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.
labelstringOptionalAn optional label for the attachment.
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_recipients_getrecipients. Catalog operation: esignature:Recipients_GetRecipients. 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.