DocuSign icon

DocuSign

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

Actions341

Envelope Document Tab → Get by Page

AI-generated

Summary

Retrieve a document tab on a specific page for an envelope.

Inputs

  • authentication — Authentication method: OAuth2 or JWT (Service Integration).
  • category — API category to work with (e.g., Envelopes, Templates).
  • accountId (required) — The DocuSign Account ID (GUID).
  • envelopeId (required) — The ID (GUID) of the envelope.
  • documentId (required) — The numeric ID of the document (use 'combined', 'archive', or 'certificate' as needed).
  • pageNumber (required) — The page number to retrieve (default is 1).

Output shape

a single EnvelopeDocumentTab object representing the tab configuration for the requested page

Only non‑empty fields are returned; if the page does not exist a 404 error is returned. The response may omit optional tabs.

Examples

Example 1: Fetch page 3 document tab details

authentication=oAuth2&category=envelopes&accountId=12345678-1234-1234-1234-1234567890ab&envelopeId=abcd1234-ef56-7890-abcd-1234567890ab&documentId=1&pageNumber=3

Example 2: Get default page for envelope

authentication=oAuth2&category=envelopes&accountId=98765432-4321-4321-4321-zyxwvutsrq98&envelopeId=98765432-efgh-3456-cdef-1234567890ab&documentId=1&pageNumber=1

Links

Discussion