DocuSign icon

DocuSign

Interact with the DocuSign eSignature REST API v2.1 — complete enterprise coverage

Actions341

Template Document Tab → Get by Page

AI-generated

Summary

Retrieve the tabs (signing fields) present on a specified page of a document within a template in a DocuSign account.

Inputs

  • Authentication — Choose between OAuth2 or JWT for authenticating with the DocuSign API.
  • Category — Select the API category context for the request (default is 'envelopes').
  • Account ID (required) — The GUID identifying the DocuSign account. Required to scope the API request.
  • Template ID (required) — The GUID of the template containing the document with the tabs to retrieve.
  • Document ID (required) — The numeric ID of the document within the template. Use special values like 'combined', 'archive', or 'certificate' if applicable.
  • Page Number (required) — The page number in the document for which to retrieve the tabs.

Output shape

a list of tabs (signing fields) located on the specified page of the given document within the template.

The response is typically an array of tab objects with their properties; no pagination is indicated.

Examples

Example 1: Get tabs on page 2 of document '1' in a specific template

Provide Account ID and Template ID, set Document ID to '1', and set Page Number to '2'.

Links

Discussion