Request

HTTP request

GET /v2/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. Eg 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

An error code associated with the error.

messagestring

A short error message.

nameValue

errorDetailserrorDetails

namestring

The name or key of a name/value pair.

originalValuestring

The initial value of the tab when it was sent to the recipient.

valuestring

The value field of a name/value pair.

recipientFormData

declinedTimestring

deliveredTimestring

emailstring

formData[nameValue]

namestring

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

sentTimestring

signedTimestring

EnvelopeFormData

emailSubjectstring

Specifies the subject of the email that is sent to all recipients.

See Template Email Subject Merge Fields for information about adding merge field information to the email subject.

envelopeIdstring

The envelope ID of the envelope status that failed to post.

formData[nameValue]

recipientFormData[recipientFormData]

sentDateTimestring

The date and time the envelope was sent.

statusstring

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.

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> 
}} />