v1

latestSwagger 2.02026-07-134146194.6 MB
EnvelopeDocumentTabs

Returns the tabs on a document.

Returns the tabs on the document specified by documentId in the envelope specified by envelopeId.

get/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

documentIdstring required

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647).

Tab objects have a documentId property that specifies the document on which to place the tab.

envelopeIdstring required

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Query parameters

include_metadatastring

When true, the response includes metadata indicating which properties are editable.

page_numbersstring

Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page GUIDs.

Example: page_numbers=2,6

Note: You can only enter individual page numbers, and not a page range.

Response

Successful response.