Skip to content

DocuSign: Gets the tabs information for a signer or sign-in-person recipient in a template

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

← Esignature operations · Get started

Operation docusign.esignature_recipients_gettemplaterecipienttabs

Provider route: GET /restapi/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs. 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"]["esignatureRecipientsGetTemplateRecipientTabs"]>[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.esignatureRecipientsGetTemplateRecipientTabs(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_recipients_get_template_recipient_tabs(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.recipientIdstringRequired within parent
path.templateIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.include_anchor_tab_locationsstringOptional
query.include_metadatastringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Deletes tabs from a template — response body

Referenced models: Deletes tabs from a template — response body

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

Returns tabs on a template — response body — prefill Tabs
FieldTypePresenceDescription and constraints
$objectRootPrefill 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
checkboxTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — checkbox Tabs item
dateTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — date Tabs item
emailTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — email Tabs item
numberTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — number Tabs item
radioGroupTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — radio Group Tabs item
senderCompanyTabsarrayOptional
senderCompanyTabs[]ModelEach itemExpand Returns tabs on a template — response body — prefill Tabs sender Name Tabs item
senderNameTabsarrayOptional
senderNameTabs[]ModelEach itemExpand Returns tabs on a template — response body — prefill Tabs sender Name Tabs item
ssnTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — ssn Tabs item
tabGroupsarrayOptionalAn 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[]ModelEach itemExpand Returns tabs on a template — response body — tab Groups item
textTabsarrayOptionalA 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[]ModelEach itemExpand Returns tabs on a template — response body — text Tabs item
zipTabsarrayOptionalA 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[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
recordIdstringOptional
Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.
Returns tabs on a template — response body — ssn Tabs item extension Data
FieldTypePresenceDescription and constraints
$objectRoot
actionContractstringOptional
actionInputKeystringOptional
actionNamestringOptional
applicationIdstringOptional
applicationNamestringOptional
connectedFieldsDataModelOptionalExpand Returns tabs on a template — response body — ssn Tabs item extension Data connected Fields Data
connectionInstancesarrayOptional
connectionInstances[]ModelEach itemExpand Returns tabs on a template — response body — ssn Tabs item extension Data connection Instances item
extensionContractstringOptional
extensionGroupIdstringOptional
extensionNamestringOptional
extensionPolicystringOptional
publisherNamestringOptional
requiredForExtensionstringOptional

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
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`
Returns tabs on a template — response body — ssn Tabs item smart Contract Information
FieldTypePresenceDescription and constraints
$objectRoot
codestringOptionalReserved for Docusign.
uristringOptionalReserved for Docusign.

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