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

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

Examples

Get all user profiles that are email addressable in a paginated format. For best results, we recommend setting a limit on your query. Send several requests to obtain the full list:

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

Get a list of email addresses from all user profiles that are addressable but not subscribed for email, in a paginated format:

curl --request POST \
  --url https://external-api.xtremepush.com/api/external/list/profile \
  --header 'content-type: application/json' \
  --data '{
    "apptoken": "YOUR_APPTOKEN",
    "select": ["email"],
    "condition": [
      ["email_subscription", "=", 0],
      ["email_addressable", "=", 1],
      ["email", "is not", null]
    ],
    "order": ["id ASC", "id"],
    "limit": 50,
    "offset": 0
  }'
Language
Click Try It! to start a request and see the response here!