Power Form Data

Returns the data that users entered in a PowerForm

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

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

You can further specify the type of CSV format in the data_layout query parameter.

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

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.

powerFormId*string

The ID of the PowerForm.

Query Parameters

data_layout?string

The layout in which to return the PowerForm data.

For each of the following layouts, set the Accept header to the corresponding value.

Valid values are:

  • Native (Set Accept header to application/json)
  • Csv_Classic (Set Accept header to application/csv)
  • Csv_One_Envelope_Per_Line (Set Accept header to text/csv)
  • Xml_Classic (Set Accept header to application/xml)
from_date?string

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

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

to_date?string

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

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/powerforms/string/form_data"
{  "envelopes": [    {      "envelopeId": "string",      "recipients": [        {          "email": "string",          "formData": [            {              "errorDetails": {                "errorCode": "string",                "message": "string"              },              "name": "string",              "originalValue": "string",              "value": "string"            }          ],          "name": "string",          "recipientId": "string"        }      ]    }  ]}