Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.include_account_settingsstringOptional
query.include_trial_eligibilitystringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieves the account information for the specified account — response body

Referenced models: Retrieves the account information for the specified account — response body

28 more schemas are linked from the tables above, on the schema pages.

Retrieves the account information for the specified account — response body
FieldTypePresenceDescription and constraints
$objectRootContains account Information.
accountIdGuidstringOptionalThe GUID associated with the account ID.
accountNamestringOptionalThe name of the current account.
accountSettingsModelOptionalExpand 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.

allowTransactionRoomsstringOptionalWhen **true,** the transaction rooms feature exposed through the Workspaces API is enabled.
billingPeriodDaysRemainingstringOptionalNumber of days remaining in the current billing period.
billingPeriodEndDatestringOptionalThe billing period end date in UTC timedate format.
billingPeriodEnvelopesAllowedstringOptionalThe number of envelopes that can be sent in the current billing period (can be unlimited).
billingPeriodEnvelopesSentstringOptionalThe number of envelopes that have been sent in the current billing period.
billingPeriodStartDatestringOptionalThe billing period start date in UTC timedate format.
billingProfilestringOptionalReserved for Docusign.
brandsModelOptionalExpand Gets a list of brands — response body
A list of brands.
canUpgradestringOptionalWhen **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.
connectPermissionstringOptionalValue is "full" when Connect is enabled for this account.
createdDatestringOptionalThe creation date of the account in UTC timedate format.
currencyCodestringOptionalSpecifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account.
currentPlanIdstringOptionalID of the plan used to create this account.
displayApplianceStartUrlstringOptional
displayApplianceUrlstringOptional
distributorCodestringOptionalThe code that identifies the billing plan groups and plans for the new account.
docuSignLandingUrlstringOptionalURL of the landing page used to create the account.
dssValuesobjectOptionalAdditional keys: see wildcard field
dssValues.*stringAdditional keys
envelopeSendingBlockedstringOptionalWhen **true,** the ability to send envelopes is blocked. When **false,** envelopes can be sent.
envelopeUnitPricestringOptionalThe price of sending an envelope, represented in the account's local currency.
externalAccountIdstringOptionalThe Account ID displayed on the user's Account page.
forgottenPasswordQuestionsCountstringOptionalA complex element that contains up to four Question/Answer pairs for forgotten password information for a user.
freeEnvelopeSendsRemainingForAdvancedDocGenJSONOptional
freeEnvelopeSendsRemainingForAdvancedDocGen (anyOf 1)integerAlternativeFormat: int32
freeEnvelopeSendsRemainingForAdvancedDocGen (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
isDowngradestringOptionalWhen **true,** the account has been downgraded from a premium account type. Otherwise **false.**
isFreeToTrialEligiblestringOptional
paymentMethodstringOptionalThe payment method used for the billing plan. Valid values are:

- `NotSupported`
- `CreditCard`
- `PurchaseOrder`
- `Premium`
- `Freemium`
- `FreeTrial`
- `AppStore`
- `DigitalExternal`
- `DirectDebit`
planClassificationstringOptionalIdentifies the type of plan. Examples include:

- `business`
- `corporate`
- `enterprise`
- `free`
planEndDatestringOptionalThe date that the current plan will end.
planNamestringOptionalThe name of the Billing Plan.
planStartDatestringOptionalThe date that the Account started using the current plan.
recipientDomainsarrayOptional
recipientDomains[]ModelEach itemExpand Retrieves the account information for the specified account — response body — recipient Domains item
seatsAllowedstringOptionalThe number of active users the account can have at one time.
seatsInUsestringOptionalThe number of users currently active on the account.
status21CFRPart11stringOptionalThe 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.
suspensionDatestringOptionalThe date on which the account was suspended.
suspensionStatusstringOptionalIndicates whether the account is currently suspended.
useDisplayAppliancebooleanOptional

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
FieldTypePresenceDescription and constraints
$objectRootThe AccountBrands resource enables you to use account-level brands to customize the styles and text that recipients see.
brandsarrayOptionalA list of brands.
brands[]ModelEach itemExpand Updates an existing brand — response body
recipientBrandIdDefaultstringOptionalThe brand that envelope recipients see when a brand is not explicitly set.
senderBrandIdDefaultstringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRoot
activestringOptional
domainCodestringOptional
domainNamestringOptional
recipientDomainIdstringOptional
Gets account settings information — response body — access Code Format
FieldTypePresenceDescription and constraints
$objectRootObject specifying the format of the string provided to a recipient in order to access an envelope.
formatRequiredstringOptionalBoolean specifying whether this format configuration is required.
formatRequiredMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `formatRequired` property is editable.
letterRequiredstringOptionalBoolean specifying whether alphabetical characters are required in the access code string.
letterRequiredMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `letterRequired` property is editable.
minimumLengthstringOptionalMinimum length of the access code string.
minimumLengthMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `minimumLength` property is editable.
numberRequiredstringOptionalBoolean specifying whether numerical characters (0-9) are required in the access code string.
numberRequiredMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `numberRequired` property is editable.
specialCharacterRequiredstringOptionalBoolean specifying whether special characters are required in the access code string. The string cannot contain the special characters '<', '>', '&', or '#'.
specialCharacterRequiredMetadataModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRootA complex element that specifies notifications (expirations and reminders) for the envelope.
expirationsModelOptionalExpand Gets envelope notification information — response body — expirations
A complex element that specifies the expiration settings for the envelope.
remindersModelOptionalExpand Gets envelope notification information — response body — reminders
A complex element that specifies reminder settings for the envelope.
userOverrideEnabledstringOptionalWhen **true,** the user can override envelope expirations.

Referenced models: Gets envelope notification information — response body — expirations, Gets envelope notification information — response body — reminders

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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.