Skip to content

DocuSign: Gets custom tab information

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

← Esignature operations · Get started

Operation docusign.esignature_tab_getcustomtab

Provider route: GET /restapi/v2.1/accounts/{accountId}/tab_definitions/{customTabId}. 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"]["esignatureTabGetCustomTab"]>[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.esignatureTabGetCustomTab(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_get_custom_tab(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
path.customTabIdstringRequired 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 Creates a custom tab — response body

Referenced models: Creates a custom tab — response body

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

Creates a custom tab — response body — merge Field
FieldTypePresenceDescription and constraints
$objectRootContains information for transferring values between Salesforce data fields and Docusign tabs.
allowSenderToEditstringOptionalWhen **true,** the sender can modify the value of the `mergeField` tab during the sending process.
allowSenderToEditMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates if the sender can edit the `allowSenderToEdit` property.
configurationTypestringOptionalIf you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.
configurationTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates if the sender can edit the `configurationType` property.
pathstringOptionalSets the object associated with the custom tab. Currently this is the Salesforce Object.
pathExtendedarrayOptionalReserved for Docusign.
pathExtended[]ModelEach itemExpand Creates a custom tab — response body — merge Field path Extended item
pathExtendedMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
pathMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `path` property is editable.
rowstringOptionalSpecifies the row number in a Salesforce table that the merge field value corresponds to.
rowMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `row` property is editable.
writeBackstringOptionalWhen **true,** data entered into the merge field during Signing will update the mapped Salesforce field.
writeBackMetadataModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRootMetadata about a property.
optionsarrayOptionalAn array of option strings supported by this setting.
options[]stringEach item
rightsstringOptionalIndicates whether the property is editable. Valid values are:

- `editable`
- `read_only`
Creates a custom tab — response body — merge Field path Extended item
FieldTypePresenceDescription and constraints
$objectRoot
namestringOptional
typestringOptionalThe 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`
typeNamestringOptional

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