Get information about all Smart Campaigns

1 min

GET

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

Get detailed information about all Smart Campaigns, such as mailing IDs and the date and time of creation.

clientIdinteger<int64>Client ID

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

limitinteger<int32>Maximum number of retrieved campaigns 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

200The Smart Campaigns 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}/smartcampaigns?resultView=SUMMARY&sort=created' \
     --header 'accept: application/json'