Get information about all confirmation mailings

1 min

GET

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

Get detailed information about all confirmation mailings, such as status, type or creation date. You can filter mailings by media type and sort the result by specific criteria.

clientIdinteger<int64>Client ID

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

limitinteger<int32>Maximum number of confirmation mailingsDefault value : 100

mediaTypestringFilter mailings by media typeAvailable values : email, sms, letter, push

resultViewstringChoose whether to retrieve a DETAILED view including all nodes (messages, recipient lists, target groups) or a SUMMARY of metadata.Note: The more campaigns you have, the more time the detailed view takes to load.

statusstringFilter mailings by statusAvailable values : invalid, activationRequired, activated, canceled, paused, running, finished

sortstringSort result by specific criteria

folderIdinteger<int64>Filter mailings assigned to a folder

directionstringSort order

acceptstringGenerated from available response content types

200A list of all confirmation mailings was retrieved (empty if none exists).

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

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