Get information about a recipient

1 min

GET

https://api.campaign.episerver.net/rest/{clientId}/recipients/{recipientListId}/{recipientId}

Get detailed information about a recipient, such as recipient ID, creation date and modification date.

clientIdinteger<int64>Client ID

recipientIdstringRecipient ID (usually the email address)

recipientListIdinteger<int64>Recipient list ID

attributeNamesarrayComma-separated names of the fields whose recipient data is to be retrieved. Example: "firstname,lastname". Note: You must use the internal names of the recipient list fields. To retrieve the attribute names of a recipient list, use the getRecipientListAttributeNames operation.

includeOptinDatabooleanSpecify whether the opt-in data fields should be returned. Only applicable for opt-in list

acceptstringGenerated from available response content types

200The recipient was retrieved successfully.

404The recipient could not be found. Ensure that the required parameters such as "recipientId" and "recipientListId" are correct and the recipient exists.

curl --request GET \
     --url https://api.campaign.episerver.net/rest/{clientId}/recipients/{recipientListId}/{recipientId} \
     --header 'accept: application/json'