Get subscription statuses from user profiles.

Further information on user profiles, device profiles and attributes can be found in the guide on user data.

🚧

Logging of profile subscription changes is turned off by default and this API method will return empty result sets. If you believe you need access to this data, please contact us.

Examples

Get a single user profile's subscription status:

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

Get all user profile subscription statuses which have updated since a certain time:

curl --request POST \
  --url https://external-api.xtremepush.com/api/external/list/profile-subscription \
  --header 'content-type: application/json' \
  --data '{
    "apptoken": "YOUR_APPTOKEN",
    "condition": [
      ["update_time", ">", 123123]
    ]
  }'

Data returned includes details of the channel and any relevant channel-specific data, for example email_address, as well as an integer-boolean status value to indicate whether the subscription was added or removed.

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