DocuSign: Retrieves the account information for the specified account
DocuSign esignature.esignatureAccountsGetAccount: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_accounts_getaccount
Provider route: GET /restapi/v2.1/accounts/{accountId}. 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"]["esignatureAccountsGetAccount"]>[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.esignatureAccountsGetAccount(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_accounts_get_account(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.include_account_settings | string | Optional | |
query.include_trial_eligibility | 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 Retrieves the account information for the specified account — response body |
Referenced models: Retrieves the account information for the specified account — response body
Schemas
Section titled “Schemas”28 more schemas are linked from the tables above, on the schema pages.
Retrieves the account information for the specified account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains account Information. |
accountIdGuid | string | Optional | The GUID associated with the account ID. |
accountName | string | Optional | The name of the current account. |
accountSettings | Model | Optional | Expand Gets account settings information — response body The list of account settings accountsettings that determine the features available for the account. Note that some features are determined by the plan used to create the account and cannot be overridden. |
allowTransactionRooms | string | Optional | When **true,** the transaction rooms feature exposed through the Workspaces API is enabled. |
billingPeriodDaysRemaining | string | Optional | Number of days remaining in the current billing period. |
billingPeriodEndDate | string | Optional | The billing period end date in UTC timedate format. |
billingPeriodEnvelopesAllowed | string | Optional | The number of envelopes that can be sent in the current billing period (can be unlimited). |
billingPeriodEnvelopesSent | string | Optional | The number of envelopes that have been sent in the current billing period. |
billingPeriodStartDate | string | Optional | The billing period start date in UTC timedate format. |
billingProfile | string | Optional | Reserved for Docusign. |
brands | Model | Optional | Expand Gets a list of brands — response body A list of brands. |
canUpgrade | string | Optional | When **true,** specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response. |
connectPermission | string | Optional | Value is "full" when Connect is enabled for this account. |
createdDate | string | Optional | The creation date of the account in UTC timedate format. |
currencyCode | string | Optional | Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account. |
currentPlanId | string | Optional | ID of the plan used to create this account. |
displayApplianceStartUrl | string | Optional | |
displayApplianceUrl | string | Optional | |
distributorCode | string | Optional | The code that identifies the billing plan groups and plans for the new account. |
docuSignLandingUrl | string | Optional | URL of the landing page used to create the account. |
dssValues | object | Optional | Additional keys: see wildcard field |
dssValues.* | string | Additional keys | |
envelopeSendingBlocked | string | Optional | When **true,** the ability to send envelopes is blocked. When **false,** envelopes can be sent. |
envelopeUnitPrice | string | Optional | The price of sending an envelope, represented in the account's local currency. |
externalAccountId | string | Optional | The Account ID displayed on the user's Account page. |
forgottenPasswordQuestionsCount | string | Optional | A complex element that contains up to four Question/Answer pairs for forgotten password information for a user. |
freeEnvelopeSendsRemainingForAdvancedDocGen | JSON | Optional | |
freeEnvelopeSendsRemainingForAdvancedDocGen (anyOf 1) | integer | Alternative | Format: int32 |
freeEnvelopeSendsRemainingForAdvancedDocGen (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
isDowngrade | string | Optional | When **true,** the account has been downgraded from a premium account type. Otherwise **false.** |
isFreeToTrialEligible | string | Optional | |
paymentMethod | string | Optional | The payment method used for the billing plan. Valid values are: - `NotSupported` - `CreditCard` - `PurchaseOrder` - `Premium` - `Freemium` - `FreeTrial` - `AppStore` - `DigitalExternal` - `DirectDebit` |
planClassification | string | Optional | Identifies the type of plan. Examples include: - `business` - `corporate` - `enterprise` - `free` |
planEndDate | string | Optional | The date that the current plan will end. |
planName | string | Optional | The name of the Billing Plan. |
planStartDate | string | Optional | The date that the Account started using the current plan. |
recipientDomains | array | Optional | |
recipientDomains[] | Model | Each item | Expand Retrieves the account information for the specified account — response body — recipient Domains item |
seatsAllowed | string | Optional | The number of active users the account can have at one time. |
seatsInUse | string | Optional | The number of users currently active on the account. |
status21CFRPart11 | string | Optional | The status of the account content per (Title 21 CFR Part 11)[https://www.fda.gov/regulatory-information/search-fda-guidance-documents/part-11-electronic-records-electronic-signatures-scope-and-application]. This regulation defines the criteria under which electronic records and electronic signatures are considered trustworthy. |
suspensionDate | string | Optional | The date on which the account was suspended. |
suspensionStatus | string | Optional | Indicates whether the account is currently suspended. |
useDisplayAppliance | boolean | Optional |
Referenced models: Gets a list of brands — response body, Gets account settings information — response body, Retrieves the account information for the specified account — response body — recipient Domains item
Gets a list of brands — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The AccountBrands resource enables you to use account-level brands to customize the styles and text that recipients see. |
brands | array | Optional | A list of brands. |
brands[] | Model | Each item | Expand Updates an existing brand — response body |
recipientBrandIdDefault | string | Optional | The brand that envelope recipients see when a brand is not explicitly set. |
senderBrandIdDefault | string | Optional | The brand that envelope senders see when a brand is not explicitly set. |
Referenced models: Updates an existing brand — response body
Retrieves the account information for the specified account — response body — recipient Domains item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active | string | Optional | |
domainCode | string | Optional | |
domainName | string | Optional | |
recipientDomainId | string | Optional |
Gets account settings information — response body — access Code Format
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Object specifying the format of the string provided to a recipient in order to access an envelope. |
formatRequired | string | Optional | Boolean specifying whether this format configuration is required. |
formatRequiredMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `formatRequired` property is editable. |
letterRequired | string | Optional | Boolean specifying whether alphabetical characters are required in the access code string. |
letterRequiredMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `letterRequired` property is editable. |
minimumLength | string | Optional | Minimum length of the access code string. |
minimumLengthMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `minimumLength` property is editable. |
numberRequired | string | Optional | Boolean specifying whether numerical characters (0-9) are required in the access code string. |
numberRequiredMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `numberRequired` property is editable. |
specialCharacterRequired | string | Optional | Boolean specifying whether special characters are required in the access code string. The string cannot contain the special characters '<', '>', '&', or '#'. |
specialCharacterRequiredMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `specialCharacterRequired` property is editable. |
Referenced models: Gets the user account settings for a specified user — response body — locale Metadata
Gets account settings information — response body — account Notification
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that specifies notifications (expirations and reminders) for the envelope. |
expirations | Model | Optional | Expand Gets envelope notification information — response body — expirations A complex element that specifies the expiration settings for the envelope. |
reminders | Model | Optional | Expand Gets envelope notification information — response body — reminders A complex element that specifies reminder settings for the envelope. |
userOverrideEnabled | string | Optional | When **true,** the user can override envelope expirations. |
Referenced models: Gets envelope notification information — response body — expirations, Gets envelope notification information — response body — reminders
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_accounts_getaccount. Catalog operation: esignature:Accounts_GetAccount. 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.