Skip to main content
GET
https://app.audienceful.com
/
api
/
people
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",
        },
    ]
}
​
search
string
An optional search parameter to find people that match the passed string. Ex: [email protected]
​
status
string
An optional parameter to find people that match the passed status.

​
Response

​
next
string or null
The API URL of the next page of users. Can be null if there are no more pages.
​
previous
string or null
The API URL of the previous page of users. Can be null if on page 0.
​
count
number
The total number of people in this dataset ignoring pagination. Example: searching for an email in your audience would return 1 or 0 here.
​
total
number
The total number of people in your list.
​
results
array
The list of people returned
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",
        },
    ]
}