Accounts: listRecipientNamesByEmail

Retrieves a list of all of the names associated with the email address that you pass in. This list can include variants of a single recipient's name that are used for signing, as well as the names of multiple different recipients.

Request

HTTP request

GET /v2.1/accounts/{accountId}/recipient_names

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Optional Query Parameters
emailstring

The email address for which you want to retrieve recipient names.

Responses

CodeDescriptionReference
200

Successful response.

recipientNamesResponse
400

Error encountered.

errorDetails

SDK Method

Accounts::listRecipientNamesByEmail

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

recipientNamesResponse

This response object contains a list of recipients.

multipleUsersstring

When set to true, the email address is used by more than one user.

recipientNames[array]

The names of the recipients associated with the email address.

reservedRecipientEmailstring

When set to true, new names cannot be added to the email address.

Examples

Generic JSON Response

Response
{
  "recipientNames": [
    "sample string 1"
  ],
  "reservedRecipientEmail": "sample string 1",
  "multipleUsers": "sample string 2"
}
Generic XML Response

Response
<recipientNamesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <multipleUsers>sample string 2</multipleUsers>
  <recipientNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
  </recipientNames>
  <reservedRecipientEmail>sample string 1</reservedRecipientEmail>
</recipientNamesResponse> 
}} />