Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string

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

powerFormId string
Optional query parameters
data_layout string
from_date string

Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.

to_date string

End of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

PowerForms::getPowerFormData

Definitions Expand All | Collapse All

PowerFormData

envelopeId string

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

recipients
[powerFormFormDataRecipient]

An array of powerform recipients.

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

nameValue

errorDetails errorDetails
name string

The name or key of a name/value pair.

originalValue string

The initial value of the tab when it was sent to the recipient.

value string

The value field of a name/value pair.

powerFormFormDataRecipient

email string
formData
[nameValue]
name string
recipientId string

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

powerFormsFormDataResponse

envelopes
[PowerFormData]

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>