docusign.power-form-data.get-power-form-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.

Returns the data that users entered in a PowerForm.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
powerformid	string	Yes	—	The ID of the PowerForm.
data_layout	string	No	—	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	No	—	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	No	—	The end date of a date range in UTC DateTime format. The default value is UtcNow.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
powerformid	string	Yes	—	The ID of the PowerForm.
data_layout	string	No	—	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	No	—	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	No	—	The end date of a date range in UTC DateTime format. The default value is UtcNow.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call GET /v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform GET /v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.power-form-data.get-power-form-form-data",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "powerformid": "value"
  }
}