This method downloads the envelope and field data from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them.

Note: To use this feature, the Sending Setting "Allow sender to download form data" must be enabled for the account.

Request

HTTP request

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

Responses

CodeDescriptionReference
200

Successful response.

EnvelopeFormData
400

Error encountered.

errorDetails

SDK Method

Envelopes::getFormData

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

formDataItem

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

listSelectedValuestring

The selected value in a list.

namestring

The name of the form field.

originalValuestring

The initial value associated with the form field.

valuestring

The current value associated with the form field.

recipientFormData

DeclinedTimestring

The date and time the recipient declined the envelope.

DeliveredTimestring

The date and time the recipient viewed the documents in the envelope in the DocuSign signing UI.

emailstring

The recipient's email address.

formData[formDataItem]

An array of form data objects.

namestring

The name of the recipient.

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

SentTimestring

The date and time the envelope was sent to the recipient.

SignedTimestring

The date and time the recipient signed the documents.

EnvelopeFormData

This object contains the data that recipients have entered into the form fields associated with an envelope.

emailSubjectstring

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.

envelopeIdstring

The id of the envelope.

formData[formDataItem]

An array of form data objects.

recipientFormData[recipientFormData]

An array of form data objects that are associated with specific recipients.

sentDateTimestring

The UTC DateTime when the envelope was sent.

statusstring

The status of the envelope. 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.

Examples

Generic JSON Response

Response
{
  "formData": [
    {}
  ],
  "envelopeId": "sample string 1",
  "status": "sample string 2",
  "emailSubject": "sample string 3",
  "sentDateTime": "sample string 4",
  "recipientFormData": [
    {
      "formData": [
        {}
      ],
      "recipientId": "sample string 1",
      "name": "sample string 2",
      "email": "sample string 3",
      "signedTime": "sample string 4",
      "sentTime": "sample string 5",
      "deliveredTime": "sample string 6",
      "declinedTime": "sample string 7"
    }
  ]
}
Generic XML Response

Response
<envelopeFormData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <emailSubject>sample string 3</emailSubject>
  <envelopeId>sample string 1</envelopeId>
  <formData>
    <nameValue />
  </formData>
  <recipientFormDataItems>
    <recipientFormData>
      <declinedTime>sample string 7</declinedTime>
      <deliveredTime>sample string 6</deliveredTime>
      <email>sample string 3</email>
      <formData>
        <nameValue />
      </formData>
      <name>sample string 2</name>
      <recipientId>sample string 1</recipientId>
      <sentTime>sample string 5</sentTime>
      <signedTime>sample string 4</signedTime>
    </recipientFormData>
  </recipientFormDataItems>
  <sentDateTime>sample string 4</sentDateTime>
  <status>sample string 2</status>
</envelopeFormData> 
}} />