v1

latestSwagger 2.02026-07-134146194.6 MB
PowerForms

Returns a list of PowerForms.

This method returns a list of PowerForms that are available to the user.

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

Path parameters

accountIdstring required

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

Query parameters

countstring

The maximum number of results to return.

from_datestring

The start date for a date range.

Note: If no value is provided, no date filtering is applied.

orderstring

The order in which to sort the results.

Valid values are:

  • asc: Ascending order.
  • desc: Descending order.
order_bystring

The file attribute to use to sort the results.

Valid values are:

  • sender
  • auth
  • used
  • remaining
  • lastused
  • status
  • type
  • templatename
  • created
search_fieldsstring

A comma-separated list of additional properties to include in a search.

  • sender: Include sender name and email in the search.
  • recipients: Include recipient names and emails in the search.
  • envelope: Include envelope information in the search.
search_textstring

Use this parameter to search for specific text.

start_positionstring

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

to_datestring

The end date for a date range.

Note: If no value is provided, this property defaults to the current date.

Response

Successful response.