Skip to content

DocuSign: Returns envelope tab data for an existing envelope

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

← Esignature operations · Get started

Operation docusign.esignature_formdata_getformdata

Provider route: GET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data. 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"]["esignatureFormDataGetFormData"]>[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.esignatureFormDataGetFormData(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_form_data_get_form_data(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

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Returns envelope tab data for an existing envelope — response body

Referenced models: Returns envelope tab data for an existing envelope — response body

Returns envelope tab data for an existing envelope — response body
FieldTypePresenceDescription and constraints
$objectRootDescribes the form data of the envelope.
emailSubjectstringOptionalThe subject line of the email message that is sent to all recipients.

For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).

**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.
envelopeIdstringOptionalThe envelope ID of the envelope status that failed to post.
formDataarrayOptionalAn array of `formDataItem` objects.
formData[]ModelEach itemExpand Returns envelope tab data for an existing envelope — response body — form Data item
prefillFormDataModelOptionalExpand Returns envelope tab data for an existing envelope — response body — prefill Form Data
An array of `formDataItem` objects for [prefill tabs](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs).
recipientFormDataarrayOptionalAn array of form data for each recipient of the envelope.
recipientFormData[]ModelEach itemExpand Returns envelope tab data for an existing envelope — response body — recipient Form Data item
sentDateTimestringOptionalThe UTC DateTime when the envelope was sent. This property is read-only.
statusstringOptionalIndicates the envelope status. Valid values are:

* sent - The envelope is sent to the recipients.
* created - The envelope is saved as a draft and can be modified and sent later.

Referenced models: Returns envelope tab data for an existing envelope — response body — form Data item, Returns envelope tab data for an existing envelope — response body — prefill Form Data, Returns envelope tab data for an existing envelope — response body — recipient Form Data item

Returns envelope tab data for an existing envelope — response body — form Data item
FieldTypePresenceDescription and constraints
$objectRoot
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
listSelectedValuestringOptionalThe selected value in a list.
namestringOptionalThe name of the form field.
numericalValuestringOptional
originalNumericalValuestringOptional
originalValuestringOptionalThe initial value associated with the form field.
valuestringOptionalThe current value associated with the form field.

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

Returns envelope tab data for an existing envelope — response body — prefill Form Data
FieldTypePresenceDescription and constraints
$objectRoot
formDataarrayOptional
formData[]ModelEach itemExpand Returns envelope tab data for an existing envelope — response body — form Data item
senderEmailstringOptionalThe sender's email address.
senderNamestringOptionalThe sender's name.
senderUserIdstringOptionalThe ID of the sender.

Referenced models: Returns envelope tab data for an existing envelope — response body — form Data item

Returns envelope tab data for an existing envelope — response body — recipient Form Data item
FieldTypePresenceDescription and constraints
$objectRoot
DeclinedTimestringOptionalThe date and time the recipient declined the envelope.
DeliveredTimestringOptionalThe date and time the recipient viewed the documents in the envelope in the Docusign signing UI.
SentTimestringOptionalThe date and time the envelope was sent to the recipient.
SignedTimestringOptionalThe date and time the recipient signed the documents.
emailstringOptionalThe recipient's email address.
formDataarrayOptionalAn array of form data objects.
formData[]ModelEach itemExpand Returns envelope tab data for an existing envelope — response body — form Data item
namestringOptionalThe name of the recipient.
recipientIdstringOptionalUnique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

Referenced models: Returns envelope tab data for an existing envelope — response body — form Data 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.

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