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.
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"]["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 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_tab_settings_get_tab_settings(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 |
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 Modifies tab settings for specified account — response body |
Referenced models: Modifies tab settings for specified account — response body
Schemas
Section titled “Schemas”Modifies tab settings for specified account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowTabOrder | string | Optional | When **true,** account users can set a tab order for the signing process. **Note:** Only Admin users can change this setting. |
allowTabOrderMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowTabOrder` property is editable. |
approveDeclineTabsEnabled | string | Optional | When **true,** approve and decline tabs are enabled. |
approveDeclineTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `approveDeclineTabs` property is editable. |
calculatedFieldsEnabled | string | Optional | When **true,** [calculated fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) are enabled for tabs. |
calculatedFieldsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `calculatedFields` property is editable. |
checkBoxTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `checkBoxTabs` property is editable. |
checkboxTabsEnabled | string | Optional | When **true,** checkbox tabs are enabled. |
dataFieldRegexEnabled | string | Optional | When **true,** regular expressions are enabled for tabs that contain data fields. |
dataFieldRegexMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `dataFieldRegex` property is editable. |
dataFieldSizeEnabled | string | Optional | When **true,** setting character limits for input fields is enabled. |
dataFieldSizeMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `dataFieldSize` property is editable. |
drawTabsEnabled | string | Optional | |
drawTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
enableTabAgreementDetails | string | Optional | |
enableTabAgreementDetailsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
firstLastEmailTabsEnabled | string | Optional | Reserved for Docusign. |
firstLastEmailTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
listTabsEnabled | string | Optional | When **true,** list tabs are enabled. |
listTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `listTabs` property is editable. |
noteTabsEnabled | string | Optional | When **true,** note tabs are enabled. |
noteTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `noteTabs` property is editable. |
numericalTabsEnabled | string | Optional | |
numericalTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
prefillTabsEnabled | string | Optional | |
prefillTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
radioTabsEnabled | string | Optional | When **true,** radio button tabs are enabled. |
radioTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `radioTabs` property is editable. |
savingCustomTabsEnabled | string | Optional | When **true,** saving custom tabs is enabled. |
savingCustomTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `savingCustomTabs` property is editable. |
senderToChangeTabAssignmentsEnabled | string | Optional | Reserved for Docusign. |
senderToChangeTabAssignmentsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
sharedCustomTabsEnabled | string | Optional | When **true,** shared custom tabs are enabled. |
sharedCustomTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `sharedCustomTabs` property is editable. |
tabDataLabelEnabled | string | Optional | When **true,** [data labels](https://support.docusign.com/en/videos/Data-Labels) are enabled. **Note:** Only Admin users can change this setting. |
tabDataLabelMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `tabDataLabel` property is editable. |
tabLocationEnabled | string | Optional | Reserved for Docusign. |
tabLocationMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
tabLockingEnabled | string | Optional | When **true,** tab locking is enabled. **Note:** Only Admin users can change this setting. |
tabLockingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `tabLocking` property is editable. |
tabScaleEnabled | string | Optional | Reserved for Docusign. |
tabScaleMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
tabTextFormattingEnabled | string | Optional | When **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. |
tabTextFormattingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `tabTextFormatting` property is editable. |
textTabsEnabled | string | Optional | When **true,** text tabs are enabled. |
textTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `textTabs` property is editable. |
uriTabsEnabled | string | Optional | |
uriTabsMetadata | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Metadata that indicates whether a property is editable and describes setting-specific options. |
is21CFRPart11 | string | Optional | When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). |
options | array | Optional | An array of option strings supported by this setting. |
options[] | string | Each item | |
rights | string | Optional | Indicates whether the property is editable. Valid values are: - `editable` - `read_only` |
uiHint | string | Optional | Reserved for Docusign. |
uiOrder | string | Optional | Reserved for Docusign. |
uiType | string | Optional | Reserved for Docusign. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.