An optional search parameter to find people that match the passed string. Ex: [email protected]
An optional parameter to find people that match the passed status. The person has not confirmed their double opt in email
The person’s email failed to deliver (permanent)
The person has unsubscribed
Response
The API URL of the next page of users. Can be null if there are no more pages.
The API URL of the previous page of users. Can be null if on page 0.
The total number of people in this dataset ignoring pagination. Example: searching for an email in your audience would return 1 or 0 here.
The total number of people in your list.
The list of people returned Notes associated with this person
All custom fields for a person An example of a custom field you may have for your audience. The data name for each field, if available, can be listed here.
The list of tags for this person This is the datetime (UTC) at which the person was created.
This is the datetime (UTC) for the last activity of this person. Example activities that update this field are: creation, open email, click email, unsubscribed from email
The status of the person. The person has not confirmed their double opt in email
The person's email failed to deliver (permanent)
The person has unsubscribed
curl --location --request GET 'https://app.audienceful.com/api/people/' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <token>'
{
"next" : null ,
"previous" : null ,
"count" : 1 ,
"results" : [
{
"uid" : "jQKdwqp3YRRtTrwqUJEp7d" ,
"email" : "[email protected] " ,
"extra_data" : {
"custom_field" : "Test data" ,
},
"tags" : [
{
"name" : "Test tag" ,
"color" : "#f5e0e9"
}
],
"created_at" : "2023-05-04T02:43:30.644651Z" ,
"last_activity" : "2023-07-31T02:44:56.122079Z" ,
"status" : "active" ,
},
]
}