Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
PowerFormData

Returns the data that users entered in a PowerForm.

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.

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

Path parameters

accountIdstring required

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

powerFormIdstring required

The ID of the PowerForm.

Query parameters

data_layoutstring

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_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.

Response

Successful response.