GET
/
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": [
        {
            "email": "support@audienceful.com",
            "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",
            "unsubscribed": "2023-07-31T02:44:56.122079Z",
        },
    ]
}
search
string

An optional search parameter to find people that match the passed string

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.

results
array

The list of people returned

total
number

The total number of people in your audience.

unsubscribed
number

The total number of unsubscribed people in your audience.

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": [
        {
            "email": "support@audienceful.com",
            "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",
            "unsubscribed": "2023-07-31T02:44:56.122079Z",
        },
    ]
}