Get information about all recipients in a recipient list

get

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

Get detailed information about all recipients in a recipient list, such as recipient ID, creation date and modification date.

Request limit: In total, a maximum of 10 simultaneous requests for the following operations are permitted per client: REST API selectRecipients, REST API countRecipients and SOAP API getCount (RecipientWebservice).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientId

int64

required

Client ID

recipientListId

int64

required

Recipient list ID

Query Params

offset

int32

Starting point of the result list

Default value : 0

limit

int32

Maximum number of recipients

Default value : 100

targetGroup

int64

ID of the matching target group

attributeNames

array of strings

Comma-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 Recipient lists operation GET /recipientlists/{recipientListId}/attributeNames.

attributeNames

includeOptinData

boolean

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

sort

string

Defaults to id

Sort result by specific criteria

direction

string

enum

Defaults to ASC

Sort order

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

429

Too many requests are used at the same time to retrieve recipients.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/vnd.optivo.broadmail.v1+json

200All relevant recipients were retrieved successfully.