Used to get a list of previously created campaigns. All campaigns may be returned or lists of campaign of a certain type if criteria are provided.

Examples

Get a list of all campaigns past and live:

curl --request POST \
  --url https://external-api.xtremepush.com/api/external/list/campaign \
  --header 'content-type: application/json' \
  --data '{
    "apptoken": "YOUR_APPTOKEN"
  }'

Get a list of all live campaigns:

curl --request POST \
  --url https://external-api.xtremepush.com/api/external/list/campaign \
  --header 'content-type: application/json' \
  --data '{
    "apptoken": "YOUR_APPTOKEN",
    "condition": [
      ["active", "=", 1]
    ]
  }'

Get all automated campaigns with a schedule live and past:

curl --request POST \
  --url https://external-api.xtremepush.com/api/external/list/campaign \
  --header 'content-type: application/json' \
  --data '{
    apptoken": "YOUR_APPTOKEN",
    "condition": [
      ["send_type", "!=", 0]
    ]
  }'

Get the most recently created campaign:

curl --request POST \
  --url https://external-api.xtremepush.com/api/external/list/campaign \
  --header 'content-type: application/json' \
  --data '{
    "apptoken":" YOUR_APPTOKEN",
    "limit": 1,
    "offset": 0
  }'

Review the campaign model properties page to see the available parameters.

Language
Click Try It! to start a request and see the response here!