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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
path.envelopeId | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Returns envelope tab data for an existing envelope — response body |
Referenced models: Returns envelope tab data for an existing envelope — response body
Schemas
Section titled “Schemas”Returns envelope tab data for an existing envelope — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes the form data of the envelope. |
emailSubject | string | Optional | The 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. |
envelopeId | string | Optional | The envelope ID of the envelope status that failed to post. |
formData | array | Optional | An array of `formDataItem` objects. |
formData[] | Model | Each item | Expand Returns envelope tab data for an existing envelope — response body — form Data item |
prefillFormData | Model | Optional | Expand 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). |
recipientFormData | array | Optional | An array of form data for each recipient of the envelope. |
recipientFormData[] | Model | Each item | Expand Returns envelope tab data for an existing envelope — response body — recipient Form Data item |
sentDateTime | string | Optional | The UTC DateTime when the envelope was sent. This property is read-only. |
status | string | Optional | Indicates 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
listSelectedValue | string | Optional | The selected value in a list. |
name | string | Optional | The name of the form field. |
numericalValue | string | Optional | |
originalNumericalValue | string | Optional | |
originalValue | string | Optional | The initial value associated with the form field. |
value | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
formData | array | Optional | |
formData[] | Model | Each item | Expand Returns envelope tab data for an existing envelope — response body — form Data item |
senderEmail | string | Optional | The sender's email address. |
senderName | string | Optional | The sender's name. |
senderUserId | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
DeclinedTime | string | Optional | The date and time the recipient declined the envelope. |
DeliveredTime | string | Optional | The date and time the recipient viewed the documents in the envelope in the Docusign signing UI. |
SentTime | string | Optional | The date and time the envelope was sent to the recipient. |
SignedTime | string | Optional | The date and time the recipient signed the documents. |
email | string | Optional | The recipient's email address. |
formData | array | Optional | An array of form data objects. |
formData[] | Model | Each item | Expand Returns envelope tab data for an existing envelope — response body — form Data item |
name | string | Optional | The name of the recipient. |
recipientId | string | Optional | Unique 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.