This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm.

You specify the format in which you want to retrieve the data in the Accept header. This header accepts the following values:

  • application/json: JSON format
  • application/xml: XML format
  • text/csv: Comma-separated value (CSV) format

Note: Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.

Request

HTTP request

GET /v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

powerFormIdstring

The id of the PowerForm.

Optional Query Parameters
data_layoutstring

The layout in which to return the PowerForm data. Valid values are:

  • Native
  • Csv_Classic
  • Csv_One_Envelope_Per_Line
  • Xml_Classic

from_datestring

The start date for a date range in UTC DateTime format.

Note: If this property is null, no date filtering is applied.

to_datestring

The end date of a date range in UTC DateTime format. The default value is UtcNow.

Responses

CodeDescriptionReference
200

Successful response.

powerFormsFormDataResponse
400

Error encountered.

errorDetails

SDK Method

PowerForms::getPowerFormData

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.

nameValue

errorDetailserrorDetails

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

namestring

The name of the item.

originalValuestring

The initial value of the item.

valuestring

The current value of the item.

powerFormFormDataRecipient

emailstring

formData[nameValue]

namestring

The name of the recipient.

recipientIdstring

The unique id for the recipient. It is used by the tab element to indicate which recipient is to sign the document.

powerFormsFormDataResponse

envelopes[PowerFormData]

An array containing PowerForm data.

PowerFormData

Data that recipients have entered in PowerForm fields.

envelopeIdstring

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

recipients[powerFormFormDataRecipient]

An array of powerform recipients.

Examples

Generic JSON Response

Response
{
  "envelopes": [
    {
      "envelopeId": "sample string 1",
      "recipients": [
        {
          "recipientId": "sample string 1",
          "email": "sample string 2",
          "name": "sample string 3",
          "formData": [
            {}
          ]
        }
      ]
    }
  ]
}
Generic XML Response

Response
<powerFormsFormDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <envelopes>
    <powerFormFormDataEnvelope>
      <envelopeId>sample string 1</envelopeId>
      <recipients>
        <powerFormFormDataRecipient>
          <email>sample string 2</email>
          <formData>
            <nameValue />
          </formData>
          <name>sample string 3</name>
          <recipientId>sample string 1</recipientId>
        </powerFormFormDataRecipient>
      </recipients>
    </powerFormFormDataEnvelope>
  </envelopes>
</powerFormsFormDataResponse> 
}} />