Get information about all recipient lists

1 min

GET

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

Get detailed information about all recipient lists, such as number of recipients, list description or suitability for transactional mails. You can limit the number of retrieved lists and include test lists.

clientIdstringClient ID

offsetinteger<int32>Starting point of the result list Default value : 0

limitinteger<int32>Maximum number of retrieved recipient lists Default value : 100

includeTestListsbooleanInclude test lists in the result set

sortstringSort result by specific criteria

directionstringSort order

acceptstringGenerated from available response content types

200The recipient lists were retrieved successfully (empty result if none was found).

400Invalid limit request. Change the limit to less than 10000.

curl --request GET \
     --url 'https://api.campaign.episerver.net/rest/{clientId}/recipientlists?includeTestLists=true&sort=created' \
     --header 'accept: application/json'