Get information about all transactional mails

1 min

GET

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

Get detailed information about all transactional mails, such as status, type, starting date, successor node or grid location. You can filter for mailings assigned to a folder or limit the number of retrieved mailings.

clientIdstringClient ID

offsetinteger<int32>Mailings offset Default value : 0

limitinteger<int32>Maximum number of transactional mails Default 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 transactional mails of a client 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}/transactionalmail?resultView=SUMMARY&sort=created' \
     --header 'accept: application/json'