Accounts: listRecipientNamesByEmail

Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query string.

Request

HTTP request

GET /v2/accounts/{accountId}/recipient_names

Parameters

Parameter name Value Description
Path parameters
accountId string

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

Optional query parameters
email string

The email address for the user

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Accounts::listRecipientNamesByEmail

Definitions Expand All | Collapse All

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

recipientNamesResponse

multipleUsers string

Indicates whether email address is used by more than one user.

recipientNames
[string]
reservedRecipientEmail string

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>