DocuSign: Gets a list of all account tabs
DocuSign esignature.esignatureTabsGetTabDefinitions: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_tabs_gettabdefinitions
Provider route: GET /restapi/v2.1/accounts/{accountId}/tab_definitions. 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"]["esignatureTabsGetTabDefinitions"]>[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.esignatureTabsGetTabDefinitions(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_tabs_get_tab_definitions(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.custom_tab_only | 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 Gets a list of all account tabs — response body |
Referenced models: Gets a list of all account tabs — response body
Schemas
Section titled “Schemas”2 more schemas are linked from the tables above, on the schema pages.
Gets a list of all account tabs — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
tabs | array | Optional | A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. |
tabs[] | Model | Each item | Expand Creates a custom tab — response body |
Referenced models: Creates a custom tab — response body
Creates a custom tab — response body — merge Field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information for transferring values between Salesforce data fields and Docusign tabs. |
allowSenderToEdit | string | Optional | When **true,** the sender can modify the value of the `mergeField` tab during the sending process. |
allowSenderToEditMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates if the sender can edit the `allowSenderToEdit` property. |
configurationType | string | Optional | If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. |
configurationTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates if the sender can edit the `configurationType` property. |
path | string | Optional | Sets the object associated with the custom tab. Currently this is the Salesforce Object. |
pathExtended | array | Optional | Reserved for Docusign. |
pathExtended[] | Model | Each item | Expand Creates a custom tab — response body — merge Field path Extended item |
pathExtendedMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Reserved for Docusign. |
pathMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `path` property is editable. |
row | string | Optional | Specifies the row number in a Salesforce table that the merge field value corresponds to. |
rowMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `row` property is editable. |
writeBack | string | Optional | When **true,** data entered into the merge field during Signing will update the mapped Salesforce field. |
writeBackMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates if the sender can edit the `writeBack` property. |
Referenced models: Creates a custom tab — response body — merge Field path Extended item, Updates a template document — response body — name Metadata
Updates a template document — response body — name Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Metadata about a property. |
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` |
Creates a custom tab — response body — merge Field path Extended item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | |
type | string | Optional | The type of this tab. Values are: - `Approve` - `CheckBox` - `Company` - `Date` - `DateSigned` - `Decline` - `Email` - `EmailAddress` - `EnvelopeId` - `FirstName` - `Formula` - `FullName` - `InitialHere` - `InitialHereOptional` - `LastName` - `List` - `Note` - `Number` - `Radio` - `SignerAttachment` - `SignHere` - `SignHereOptional` - `Ssn` - `Text` - `Title` - `Zip5` - `Zip5Dash4` |
typeName | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_tabs_gettabdefinitions. Catalog operation: esignature:Tabs_GetTabDefinitions. 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.