Retrieves the bulk recipient file information from a template that has a bulk recipient.

Request

HTTP request

GET /v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

recipientIdstring

The recipientId used when the envelope or template was created.

templateIdstring

The ID of the template being accessed.

Optional Query Parameters
include_tabsstring

When set to true, the tab information associated with the recipient is included in the response.

start_positionstring

Reserved for DocuSign.

Responses

CodeDescriptionReference
200

Successful response.

TemplateBulkRecipients
400

Error encountered.

errorDetails

SDK Method

Templates::listBulkRecipients

Definitions

bulkRecipient
bulkRecipientSignatureProvider
bulkRecipientTabLabel
errorDetails
TemplateBulkRecipients

Examples

Generic JSON Response
Generic XML Response