Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

powerFormIdstring

Optional Query Parameters
data_layoutstring

from_datestring

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_datestring

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

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

An error code associated with the error.

messagestring

A short error message.

nameValue

errorDetailserrorDetails

namestring

The name or key of a name/value pair.

originalValuestring

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

valuestring

The value field of a name/value pair.

powerFormFormDataRecipient

emailstring

formData[nameValue]

namestring

recipientIdstring

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

powerFormsFormDataResponse

envelopes[PowerFormData]

PowerFormData

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> 
}} />