This method returns information about the tab types and tab functionality that is currently enabled for an account.

Request

HTTP request

GET /v2.1/accounts/{accountId}/settings/tabs

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

Responses

CodeDescriptionReference
200

Successful response.

AccountTabSettings
400

Error encountered.

errorDetails

SDK Method

Accounts::getAccountTabSettings

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

settingsMetadata

Metadata that indicates whether a property is editable and describes setting-specific options.

is21CFRPart11string

When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).

options[array]

An array of option strings supported by this setting.

rightsstring

Indicates whether the property is editable. Valid values are:

  • editable
  • read_only

uiHintstring

Reserved for DocuSign.

uiOrderstring

Reserved for DocuSign.

uiTypestring

Reserved for DocuSign.

AccountTabSettings

Tab settings determine the tab types and tab functionality that are enabled for an account.

allowTabOrderstring

When true, account users can set a tab order for the signing process.

allowTabOrderMetadatasettingsMetadata

Metadata that indicates whether the allowTabOrder property is editable.

approveDeclineTabsEnabledstring

When true, approve and decline tabs are enabled.

approveDeclineTabsMetadatasettingsMetadata

Metadata that indicates whether the approveDeclineTabs property is editable.

calculatedFieldsEnabledstring

When true, calculated fields are enabled for tabs.

calculatedFieldsMetadatasettingsMetadata

Metadata that indicates whether the calculatedFields property is editable.

checkboxTabsEnabledstring

When true, checkbox tabs are enabled.

checkBoxTabsMetadatasettingsMetadata

Metadata that indicates whether the checkBoxTabs property is editable.

dataFieldRegexEnabledstring

When true, regular expressions are enabled for tabs that contain data fields.

dataFieldRegexMetadatasettingsMetadata

Metadata that indicates whether the dataFieldRegex property is editable.

dataFieldSizeEnabledstring

When true, setting character limits for input fields is enabled.

dataFieldSizeMetadatasettingsMetadata

Metadata that indicates whether the dataFieldSize property is editable.

firstLastEmailTabsEnabledstring

Reserved for DocuSign.

firstLastEmailTabsMetadatasettingsMetadata

Reserved for DocuSign.

listTabsEnabledstring

When true, list tabs are enabled.

listTabsMetadatasettingsMetadata

Metadata that indicates whether the listTabs property is editable.

noteTabsEnabledstring

When true, note tabs are enabled.

noteTabsMetadatasettingsMetadata

Metadata that indicates whether the noteTabs property is editable.

radioTabsEnabledstring

When true, radio button tabs are enabled.

radioTabsMetadatasettingsMetadata

Metadata that indicates whether the radioTabs property is editable.

savingCustomTabsEnabledstring

When true, saving custom tabs is enabled.

savingCustomTabsMetadatasettingsMetadata

Metadata that indicates whether the savingCustomTabs property is editable.

senderToChangeTabAssignmentsEnabledstring

Reserved for DocuSign.

senderToChangeTabAssignmentsMetadatasettingsMetadata

Reserved for DocuSign.

sharedCustomTabsEnabledstring

When true, shared custom tabs are enabled.

sharedCustomTabsMetadatasettingsMetadata

Metadata that indicates whether the sharedCustomTabs property is editable.

tabDataLabelEnabledstring

When true, data labels are enabled.

tabDataLabelMetadatasettingsMetadata

Metadata that indicates whether the tabDataLabel property is editable.

tabLocationEnabledstring

Reserved for DocuSign.

tabLocationMetadatasettingsMetadata

Reserved for DocuSign.

tabLockingEnabledstring

When true, tab locking is enabled.

tabLockingMetadatasettingsMetadata

Metadata that indicates whether the tabLocking property is editable.

tabScaleEnabledstring

Reserved for DocuSign.

tabScaleMetadatasettingsMetadata

Reserved for DocuSign.

tabTextFormattingEnabledstring

When true, tab text formatting is enabled.

tabTextFormattingMetadatasettingsMetadata

Metadata that indicates whether the tabTextFormatting property is editable.

textTabsEnabledstring

When true, text tabs are enabled.

textTabsMetadatasettingsMetadata

Metadata that indicates whether the textTabs property is editable.

Examples

Generic JSON Response

Response
{
  "textTabsEnabled": "sample string 1",
  "textTabsMetadata": {
    "rights": "sample string 1",
    "uiHint": "sample string 2",
    "uiType": "sample string 3",
    "uiOrder": "sample string 4",
    "is21CFRPart11": "sample string 5",
    "options": [
      "sample string 1"
    ]
  },
  "radioTabsEnabled": "sample string 2",
  "radioTabsMetadata": {},
  "checkboxTabsEnabled": "sample string 3",
  "checkboxTabsMetadata": {},
  "listTabsEnabled": "sample string 4",
  "listTabsMetadata": {},
  "approveDeclineTabsEnabled": "sample string 5",
  "approveDeclineTabsMetadata": {},
  "noteTabsEnabled": "sample string 6",
  "noteTabsMetadata": {},
  "dataFieldRegexEnabled": "sample string 7",
  "dataFieldRegexMetadata": {},
  "dataFieldSizeEnabled": "sample string 8",
  "dataFieldSizeMetadata": {},
  "tabLocationEnabled": "sample string 9",
  "tabLocationMetadata": {},
  "tabScaleEnabled": "sample string 10",
  "tabScaleMetadata": {},
  "tabLockingEnabled": "sample string 11",
  "tabLockingMetadata": {},
  "savingCustomTabsEnabled": "sample string 12",
  "savingCustomTabsMetadata": {},
  "tabTextFormattingEnabled": "sample string 13",
  "tabTextFormattingMetadata": {},
  "sharedCustomTabsEnabled": "sample string 14",
  "sharedCustomTabsMetadata": {},
  "senderToChangeTabAssignmentsEnabled": "sample string 15",
  "senderToChangeTabAssignmentsMetadata": {},
  "tabDataLabelEnabled": "sample string 16",
  "tabDataLabelMetadata": {},
  "firstLastEmailTabsEnabled": "sample string 17",
  "firstLastEmailTabsMetadata": {},
  "calculatedFieldsEnabled": "sample string 18",
  "calculatedFieldsMetadata": {},
  "allowTabOrder": "sample string 19",
  "allowTabOrderMetadata": {}
}
Generic XML Response

Response
<tabAccountSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <allowTabOrder>sample string 19</allowTabOrder>
  <allowTabOrderMetadata />
  <approveDeclineTabsEnabled>sample string 5</approveDeclineTabsEnabled>
  <approveDeclineTabsMetadata />
  <calculatedFieldsEnabled>sample string 18</calculatedFieldsEnabled>
  <calculatedFieldsMetadata />
  <checkboxTabsEnabled>sample string 3</checkboxTabsEnabled>
  <checkboxTabsMetadata />
  <dataFieldRegexEnabled>sample string 7</dataFieldRegexEnabled>
  <dataFieldRegexMetadata />
  <dataFieldSizeEnabled>sample string 8</dataFieldSizeEnabled>
  <dataFieldSizeMetadata />
  <firstLastEmailTabsEnabled>sample string 17</firstLastEmailTabsEnabled>
  <firstLastEmailTabsMetadata />
  <listTabsEnabled>sample string 4</listTabsEnabled>
  <listTabsMetadata />
  <noteTabsEnabled>sample string 6</noteTabsEnabled>
  <noteTabsMetadata />
  <radioTabsEnabled>sample string 2</radioTabsEnabled>
  <radioTabsMetadata />
  <savingCustomTabsEnabled>sample string 12</savingCustomTabsEnabled>
  <savingCustomTabsMetadata />
  <senderToChangeTabAssignmentsEnabled>sample string 15</senderToChangeTabAssignmentsEnabled>
  <senderToChangeTabAssignmentsMetadata />
  <sharedCustomTabsEnabled>sample string 14</sharedCustomTabsEnabled>
  <sharedCustomTabsMetadata />
  <tabDataLabelEnabled>sample string 16</tabDataLabelEnabled>
  <tabDataLabelMetadata />
  <tabLocationEnabled>sample string 9</tabLocationEnabled>
  <tabLocationMetadata />
  <tabLockingEnabled>sample string 11</tabLockingEnabled>
  <tabLockingMetadata />
  <tabScaleEnabled>sample string 10</tabScaleEnabled>
  <tabScaleMetadata />
  <tabTextFormattingEnabled>sample string 13</tabTextFormattingEnabled>
  <tabTextFormattingMetadata />
  <textTabsEnabled>sample string 1</textTabsEnabled>
  <textTabsMetadata>
    <is21CFRPart11>sample string 5</is21CFRPart11>
    <options>
      <string>sample string 1</string>
    </options>
    <rights>sample string 1</rights>
    <uiHint>sample string 2</uiHint>
    <uiOrder>sample string 4</uiOrder>
    <uiType>sample string 3</uiType>
  </textTabsMetadata>
</tabAccountSettings> 
}} />