Envelope Form Data

Returns envelope tab data for an existing envelope

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

This method downloads the envelope and tab data (also called form 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.

Related topics

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

envelopeId*string

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/envelopes/string/form_data"
{  "emailSubject": "string",  "envelopeId": "string",  "formData": [    {      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "listSelectedValue": "string",      "name": "string",      "numericalValue": "string",      "originalNumericalValue": "string",      "originalValue": "string",      "value": "string"    }  ],  "prefillFormData": {    "formData": [      {        "errorDetails": {          "errorCode": "string",          "message": "string"        },        "listSelectedValue": "string",        "name": "string",        "numericalValue": "string",        "originalNumericalValue": "string",        "originalValue": "string",        "value": "string"      }    ],    "senderEmail": "string",    "senderName": "string",    "senderUserId": "string"  },  "recipientFormData": [    {      "DeclinedTime": "string",      "DeliveredTime": "string",      "email": "string",      "formData": [        {          "errorDetails": {            "errorCode": "string",            "message": "string"          },          "listSelectedValue": "string",          "name": "string",          "numericalValue": "string",          "originalNumericalValue": "string",          "originalValue": "string",          "value": "string"        }      ],      "name": "string",      "recipientId": "string",      "SentTime": "string",      "SignedTime": "string"    }  ],  "sentDateTime": "string",  "status": "string"}