DocuSign: Returns a single Power Form
DocuSign esignature.esignaturePowerFormsGetPowerForm: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_powerforms_getpowerform
Provider route: GET /restapi/v2.1/accounts/{accountId}/powerforms/{powerFormId}. 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"]["esignaturePowerFormsGetPowerForm"]>[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.esignaturePowerFormsGetPowerForm(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_form(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 | |
path.powerFormId | string | Required within parent |
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 Creates a new Power Form — response body |
Referenced models: Creates a new Power Form — response body
Schemas
Section titled “Schemas”143 more schemas are linked from the tables above, on the schema pages.
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. |
Creates a new Power Form — response body — recipients item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | **Note:** For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`. |
accessCode | string | Optional | (Optional) The access code that the recipient must enter to access the PowerForm. Maximum Length: 50 characters. The code must also conform to the account's access code format setting. If blank but the signer accessCode property is set in the envelope, then that value is used. If blank and the signer accessCode property is not set, then the access code is not required. |
accessCodeLocked | string | Optional | When **true,** the `accessCode` property is locked and cannot be edited. |
accessCodeRequired | string | Optional | When **true,** the recipient must enter the `accessCode` to access the PowerForm. |
email | string | Optional | The email address of the recipient. **Note:** For self-service documents where you do not know who the recipients are in advance, you can leave this property blank. |
emailLocked | string | Optional | When **true,** the recipient's email address is locked and cannot be edited. |
idCheckConfigurationName | string | Optional | The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **Example:** Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. |
idCheckRequired | string | Optional | Indicates if authentication is configured for the account. Valid values are: - `always`: Authentication checks are performed on every envelope. - `never`: Authentication checks are not performed on any envelopes. - `optional:` Authentication is configurable per envelope. |
name | string | Optional | The name of the PowerForm recipient. **Note:** For self-service documents where you do not know who the recipients are in advance, you can leave this property blank. |
recipientType | string | Optional | The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. |
roleName | string | Optional | The role associated with the recipient (for example, `Member`). This property is required when you are working with template recipients and PowerForm recipients. |
routingOrder | string | Optional | Specifies the routing order of the recipient in the envelope. |
templateRequiresIdLookup | string | Optional | When **true,** the template used to create the PowerForm requires ID lookup for the recipient. |
userNameLocked | string | Optional | When **true,** the `userName` property for the recipient is locked and cannot be edited. |
Gets the status of a single envelope — response body — envelope Custom Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
envelopeCustomMetadataDetails | array | Optional | |
envelopeCustomMetadataDetails[] | Model | Each item | Expand Updates an existing brand — response body — colors item |
Referenced models: Updates an existing brand — response body — colors item
Deletes recipients from a template — response body — seals item recipient Feature Metadata item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
availabilty | string | Optional | |
featureName | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_powerforms_getpowerform. Catalog operation: esignature:PowerForms_GetPowerForm. 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.