TemplateRecipientTabs

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

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

get/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs

Request

  • Base URL
    https://www.docusign.net/restapi
  • URL
    https://www.docusign.net/restapi/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs
  • Auth
    none declared

Path parameters

accountIdstring required

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

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.

templateIdstring required

The ID of the template.

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.

Changes

No recorded changes to this operation across all 39 revisions of this API.