DocuSign: Returns a list of Power Forms
DocuSign esignature.esignaturePowerFormsGetPowerFormsList: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_powerforms_getpowerformslist
Provider route: GET /restapi/v2.1/accounts/{accountId}/powerforms. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignaturePowerFormsGetPowerFormsList"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.esignature.esignaturePowerFormsGetPowerFormsList(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.esignature.esignature_power_forms_get_power_forms_list(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.count | string | Optional | |
query.from_date | string | Optional | |
query.order | string | Optional | |
query.order_by | string | Optional | |
query.search_fields | string | Optional | |
query.search_text | string | Optional | |
query.start_position | string | Optional | |
query.to_date | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Returns a list of Power Forms — response body |
Referenced models: Returns a list of Power Forms — response body
Schemas
Section titled “Schemas”144 more schemas are linked from the tables above, on the schema pages.
Returns a list of Power Forms — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of PowerForms. |
endPosition | JSON | Optional | |
endPosition (anyOf 1) | integer | Alternative | The last index position in the result set. Format: int32 |
endPosition (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
powerForms | array | Optional | An array of PowerForm objects. |
powerForms[] | Model | Each item | Expand Creates a new Power Form — response body |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | JSON | Optional | |
resultSetSize (anyOf 1) | integer | Alternative | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. Format: int32 |
resultSetSize (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startPosition | JSON | Optional | |
startPosition (anyOf 1) | integer | Alternative | The starting index position of the current result set. Format: int32 |
startPosition (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
totalSetSize | JSON | Optional | |
totalSetSize (anyOf 1) | integer | Alternative | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. Format: int32 |
totalSetSize (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Creates a new Power Form — response body
Creates a new Power Form — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains details about a PowerForm. |
createdBy | string | Optional | The ID of the user who created the PowerForm. |
createdDateTime | string | Optional | The UTC DateTime when the item was created. |
emailBody | string | Optional | The body of the email message sent to the recipients. Maximum length: 10000 characters. |
emailSubject | string | Optional | The subject line of the email message that is sent to all recipients. For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields). **Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters. |
envelopes | array | Optional | |
envelopes[] | Model | Each item | Expand Gets the status of a single envelope — response body |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
instructions | string | Optional | The instructions that display on the landing page for the first recipient. These instructions are important if the recipient accesses the PowerForm by a method other than email. If instructions are entered, they display as an introduction after the recipient accesses the PowerForm. Limit: 2000 characters. |
isActive | string | Optional | When **true,** indicates that the PowerForm is active and can be sent to recipients. This is the default value. When **false,** the PowerForm cannot be emailed or accessed by a recipient, even if they arrive at the PowerForm URL. If a recipient attempts to sign an inactive PowerForm, an error message informs the recipient that the document is not active and suggests that they contact the sender. |
lastUsed | string | Optional | The UTC DateTime when the PowerForm was last used. |
limitUseInterval | string | Optional | The length of time before the same recipient can sign the same PowerForm. This property is used in combination with the `limitUseIntervalUnits` property. |
limitUseIntervalEnabled | string | Optional | When **true,** the `limitUseInterval` is enabled. |
limitUseIntervalUnits | string | Optional | The units associated with the `limitUseInterval`. Valid values are: - `minutes` - `hours - `days` - `weeks` - `months` For example, to limit a recipient to signing once per year, set the `limitUseInterval` to 365 and the `limitUseIntervalUnits` to `days`. |
maxUseEnabled | string | Optional | When **true,** you can set a maximum number of uses for the PowerForm. |
name | string | Optional | The name of the PowerForm. |
powerFormId | string | Optional | The ID of the PowerForm. |
powerFormUrl | string | Optional | The URL for the PowerForm. |
recipients | array | Optional | An array of recipient objects that provides details about the recipients of the envelope. |
recipients[] | Model | Each item | Expand Creates a new Power Form — response body — recipients item |
senderName | string | Optional | The sender's name. |
senderUserId | string | Optional | The ID of the sender. |
signingMode | string | Optional | The signing mode to use. Valid values are: - `email`: Verifies the recipient's identity using email authentication before the recipient can sign a document. The recipient enters their email address and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code for the PowerForm to the recipient. If the recipient does not provide a valid email address, they cannot open and sign the document. - `direct`: Does not require any verification. After a recipient enters their email address and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process. Because the recipient's identity is not verified by using email authentication, we strongly recommend that you only use the `direct` signing mode when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the Docusign template (for example, an access code, phone authentication, or ID check). **Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`. |
templateId | string | Optional | The ID of the template used to create the PowerForm. |
templateName | string | Optional | The name of the template used to create the PowerForm. |
timesUsed | string | Optional | The number of times the PowerForm has been used. |
uri | string | Optional | The URI for the PowerForm. |
usesRemaining | string | Optional | The number of times the PowerForm can still be used. |
Referenced models: Gets the status of a single envelope — response body, Locks a template — response body — error Details, Creates a new Power Form — response body — recipients item
Locks a template — response body — error Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Gets a list of custom fields — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An `accountCustomField` is an envelope custom field that you set at the account level. Applying custom fields enables account administrators to group and manage envelopes. |
listCustomFields | array | Optional | An array of list custom fields. |
listCustomFields[] | Model | Each item | Expand Gets a list of custom fields — response body — list Custom Fields item |
textCustomFields | array | Optional | An array of text custom fields. |
textCustomFields[] | Model | Each item | Expand Gets a list of custom fields — response body — text Custom Fields item |
Referenced models: Gets a list of custom fields — response body — list Custom Fields item, Gets a list of custom fields — response body — text Custom Fields item
Locks an envelope — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Envelope locks let you lock an envelope to prevent any changes while you are updating an envelope. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
lockDurationInSeconds | string | Optional | The number of seconds until the lock expires when there is no activity on the envelope. The default value is 300 seconds. The maximum value is 1,800 seconds. The lock duration can be extended. |
lockToken | string | Optional | A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock. |
lockType | string | Optional | The type of lock. Currently `edit` is the only supported type. |
lockedByApp | string | Optional | The human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur. |
lockedByUser | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner A complex type containing information about the user that has the envelope or template locked. |
lockedUntilDateTime | string | Optional | The date and time that the lock expires. |
useScratchPad | string | Optional | When **true,** a scratchpad is used to edit information. |
Referenced models: Locks a template — response body — error Details, Gets a specific template associated with a specified account — response body — owner
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_powerforms_getpowerformslist. Catalog operation: esignature:PowerForms_GetPowerFormsList. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.