DocuSign: Returns tabs on the specified page — esignature esignature Tabs Get Page Tabs
DocuSign esignature.esignatureTabsGetPageTabs: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_tabs_getpagetabs
Provider route: GET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/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"]["esignatureTabsGetPageTabs"]>[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.esignatureTabsGetPageTabs(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_page_tabs(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 | |
path.documentId | string | Required within parent | |
path.envelopeId | string | Required within parent | |
path.pageNumber | 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 Returns the tabs on a document — response body |
Referenced models: Returns the tabs on a document — response body
Schemas
Section titled “Schemas”59 more schemas are linked from the tables above, on the schema pages.
Returns tabs on a template — response body — prefill Tabs
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. Only the following tab types can be prefill tabs: - text - check boxes - radio buttons [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields |
checkboxTabs | array | Optional | A list of [Checkbox tabs][checkbox]. A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. [checkbox]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
checkboxTabs[] | Model | Each item | Expand Returns tabs on a template — response body — checkbox Tabs item |
dateTabs | array | Optional | A list of [Date tabs][date]. A Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters. **Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message. [date]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
dateTabs[] | Model | Each item | Expand Returns tabs on a template — response body — date Tabs item |
emailTabs | array | Optional | A list of [Email tabs][email]. An Email tab enables the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. This value can be set. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. [email]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
emailTabs[] | Model | Each item | Expand Returns tabs on a template — response body — email Tabs item |
numberTabs | array | Optional | A list of Number tabs. Number tabs validate that the entered value is a number. They do not support advanced validation or display options. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about number tabs see [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs). [number]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
numberTabs[] | Model | Each item | Expand Returns tabs on a template — response body — number Tabs item |
radioGroupTabs | array | Optional | A list of [Radio Group tabs][radioGroup]. A Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value can be set. [radioGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
radioGroupTabs[] | Model | Each item | Expand Returns tabs on a template — response body — radio Group Tabs item |
senderCompanyTabs | array | Optional | |
senderCompanyTabs[] | Model | Each item | Expand Returns tabs on a template — response body — prefill Tabs sender Name Tabs item |
senderNameTabs | array | Optional | |
senderNameTabs[] | Model | Each item | Expand Returns tabs on a template — response body — prefill Tabs sender Name Tabs item |
ssnTabs | array | Optional | A list of [SSN tabs][ssn]. An SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. [ssn]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
ssnTabs[] | Model | Each item | Expand Returns tabs on a template — response body — ssn Tabs item |
tabGroups | array | Optional | An array of `tabGroup` items. To associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array. |
tabGroups[] | Model | Each item | Expand Returns tabs on a template — response body — tab Groups item |
textTabs | array | Optional | A list of Text tabs. A text tab enables the recipient to enter free text. This value can be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource][ert]. [ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
textTabs[] | Model | Each item | Expand Returns tabs on a template — response body — text Tabs item |
zipTabs | array | Optional | A list of [Zip tabs][zip]. A Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. [zip]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
zipTabs[] | Model | Each item | Expand Returns tabs on a template — response body — zip Tabs item |
Referenced models: Returns tabs on a template — response body — checkbox Tabs item, Returns tabs on a template — response body — date Tabs item, Returns tabs on a template — response body — email Tabs item, Returns tabs on a template — response body — number Tabs item, Returns tabs on a template — response body — radio Group Tabs item, Returns tabs on a template — response body — prefill Tabs sender Name Tabs item, Returns tabs on a template — response body — ssn Tabs item, Returns tabs on a template — response body — tab Groups item, Returns tabs on a template — response body — text Tabs item, Returns tabs on a template — response body — zip Tabs item
Returns tabs on a template — response body — ssn Tabs item connected Object Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
recordId | string | Optional |
Locks a template — response body — error Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Returns tabs on a template — response body — ssn Tabs item extension Data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actionContract | string | Optional | |
actionInputKey | string | Optional | |
actionName | string | Optional | |
applicationId | string | Optional | |
applicationName | string | Optional | |
connectedFieldsData | Model | Optional | Expand Returns tabs on a template — response body — ssn Tabs item extension Data connected Fields Data |
connectionInstances | array | Optional | |
connectionInstances[] | Model | Each item | Expand Returns tabs on a template — response body — ssn Tabs item extension Data connection Instances item |
extensionContract | string | Optional | |
extensionGroupId | string | Optional | |
extensionName | string | Optional | |
extensionPolicy | string | Optional | |
publisherName | string | Optional | |
requiredForExtension | string | Optional |
Referenced models: Returns tabs on a template — response body — ssn Tabs item extension Data connected Fields Data, Returns tabs on a template — response body — ssn Tabs item extension Data connection Instances item
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` |
Returns tabs on a template — response body — ssn Tabs item smart Contract Information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Optional | Reserved for Docusign. |
uri | string | Optional | Reserved for Docusign. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_tabs_getpagetabs. Catalog operation: esignature:Tabs_GetPageTabs. 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.