v1

latestSwagger 2.02026-07-134146194.6 MB

EnvelopeRecipientTabs

Gets the tabs information for a signer or sign-in-person recipient in an envelope.

Retrieves information about the tabs associated with a recipient. You can make a single API call to get all the tab values and information from a given, completed envelope in addition to draft ones. Tab values can be retrieved by using the EnvelopeRecipients:list method with query parameter include_tabs set to true.

get/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

Path parameters

accountIdstring required

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

envelopeIdstring required

The envelope's GUID.

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

recipientIdstring required

A local reference used to map recipients to other objects, such as specific document tabs.

A recipientId must be either an integer or a GUID, and the recipientId must be unique within an envelope.

For example, many envelopes assign the first recipient a recipientId of 1.

Query parameters

include_anchor_tab_locationsstring

When true, all tabs with anchor tab properties are included in the response. The default value is false.

include_metadatastring

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

Response

Successful response.