Skip to content

DocuSign: Returns tab settings list for specified account

DocuSign esignature.esignatureTabSettingsGetTabSettings: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_tabsettings_gettabsettings

Provider route: GET /restapi/v2.1/accounts/{accountId}/settings/tabs. 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"]["esignatureTabSettingsGetTabSettings"]>[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.esignatureTabSettingsGetTabSettings(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_tab_settings_get_tab_settings(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

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Modifies tab settings for specified account — response body

Referenced models: Modifies tab settings for specified account — response body

Modifies tab settings for specified account — response body
FieldTypePresenceDescription and constraints
$objectRoot
allowTabOrderstringOptionalWhen **true,** account users can set a tab order for the signing process.

**Note:** Only Admin users can change this setting.
allowTabOrderMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `allowTabOrder` property is editable.
approveDeclineTabsEnabledstringOptionalWhen **true,** approve and decline tabs are enabled.
approveDeclineTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `approveDeclineTabs` property is editable.
calculatedFieldsEnabledstringOptionalWhen **true,** [calculated fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) are enabled for tabs.
calculatedFieldsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `calculatedFields` property is editable.
checkBoxTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `checkBoxTabs` property is editable.
checkboxTabsEnabledstringOptionalWhen **true,** checkbox tabs are enabled.
dataFieldRegexEnabledstringOptionalWhen **true,** regular expressions are enabled for tabs that contain data fields.
dataFieldRegexMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `dataFieldRegex` property is editable.
dataFieldSizeEnabledstringOptionalWhen **true,** setting character limits for input fields is enabled.
dataFieldSizeMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `dataFieldSize` property is editable.
drawTabsEnabledstringOptional
drawTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
enableTabAgreementDetailsstringOptional
enableTabAgreementDetailsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
firstLastEmailTabsEnabledstringOptionalReserved for Docusign.
firstLastEmailTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
listTabsEnabledstringOptionalWhen **true,** list tabs are enabled.
listTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `listTabs` property is editable.
noteTabsEnabledstringOptionalWhen **true,** note tabs are enabled.
noteTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `noteTabs` property is editable.
numericalTabsEnabledstringOptional
numericalTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
prefillTabsEnabledstringOptional
prefillTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
radioTabsEnabledstringOptionalWhen **true,** radio button tabs are enabled.
radioTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `radioTabs` property is editable.
savingCustomTabsEnabledstringOptionalWhen **true,** saving custom tabs is enabled.
savingCustomTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `savingCustomTabs` property is editable.
senderToChangeTabAssignmentsEnabledstringOptionalReserved for Docusign.
senderToChangeTabAssignmentsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
sharedCustomTabsEnabledstringOptionalWhen **true,** shared custom tabs are enabled.
sharedCustomTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `sharedCustomTabs` property is editable.
tabDataLabelEnabledstringOptionalWhen **true,** [data
labels](https://support.docusign.com/en/videos/Data-Labels) are enabled.

**Note:** Only Admin users can change this setting.
tabDataLabelMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `tabDataLabel` property is editable.
tabLocationEnabledstringOptionalReserved for Docusign.
tabLocationMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
tabLockingEnabledstringOptionalWhen **true,** tab locking is enabled.

**Note:** Only Admin users can change this setting.
tabLockingMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `tabLocking` property is editable.
tabScaleEnabledstringOptionalReserved for Docusign.
tabScaleMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
tabTextFormattingEnabledstringOptionalWhen **true,** text formatting (such as font type, font size,
font color, bold, italic, and underline) is enabled for tabs that
support formatting.

**Note:** Only Admin users can change this setting.
tabTextFormattingMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `tabTextFormatting` property is editable.
textTabsEnabledstringOptionalWhen **true,** text tabs are enabled.
textTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `textTabs` property is editable.
uriTabsEnabledstringOptional
uriTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata

Referenced models: Gets the user account settings for a specified user — response body — locale Metadata

Gets the user account settings for a specified user — response body — locale Metadata
FieldTypePresenceDescription and constraints
$objectRootMetadata that indicates whether a property is editable and describes setting-specific options.
is21CFRPart11stringOptionalWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
optionsarrayOptionalAn array of option strings supported by this setting.
options[]stringEach item
rightsstringOptionalIndicates whether the property is editable. Valid values are:

- `editable`
- `read_only`
uiHintstringOptionalReserved for Docusign.
uiOrderstringOptionalReserved for Docusign.
uiTypestringOptionalReserved for Docusign.

SDK function policy ID: docusign.esignature_tabsettings_gettabsettings. Catalog operation: esignature:TabSettings_GetTabSettings. 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.