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.
{
"apptoken": "YOUR_APPTOKEN",
"condition": [
[
"email_addressable",
"=",
"0"
]
],
"limit": "50",
"offset": "0"
}{
"apptoken": "YOUR_APPTOKEN",
"select": [
"email"
],
"condition": [
[
"email_subscription",
"=",
"0"
],
[
"email_addressable",
"=",
"1"
],
[
"email",
"is not",
null
]
],
"order": [
"id ASC",
"id"
],
"limit": "50",
"offset": "0"
}Your App token
Order the results in either ascending or descending order based on any of the attributes, eg. ["id ASC", "email"] or ["id DESC", "email"]
Select what attributes to return, eg. ["id", "project_id", "user_id", "email", "email_addressable"]
Filter the user profiles based on some criteria, eg. [ ["email_addressable", "=" , 1] ]
Used with offset for pagination, eg. "limit": 50, "offset": 0 returns a max of 50 results starting at position 0
Used with limit for pagination
200
{
"success": "True",
"code": "200",
"data": [
{
"id": "11eb0ca1064e5d178bc7061c72c7ac00",
"email": "info@example.com",
"email_addressable": "1",
"email_subscription": "1",
"timezone": "Europe/Dublin"
}
]
}400
{
"success": "False",
"code": "400",
"message": "General error information"
}