Skip to main content
GET
/
people
List People
curl --request GET \
  --url https://{defaultHost}/people \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "person_id": "<string>",
      "first_seen_at": 123,
      "last_seen_at": 123,
      "purchase_count": 123,
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "has_failed_payment": true,
      "ltv": 123,
      "aov": 123,
      "campaigns": [
        {
          "id": "<string>",
          "name": "<string>",
          "thumbnail_url": "<string>"
        }
      ],
      "ad_sets": [
        {
          "id": "<string>",
          "name": "<string>",
          "thumbnail_url": "<string>"
        }
      ],
      "ads": [
        {
          "id": "<string>",
          "name": "<string>",
          "thumbnail_url": "<string>"
        }
      ]
    }
  ],
  "total_count": 123
}

Authorizations

Authorization
string
header
required

An account API key, account scoped JWT, app API key, or user OAuth token.

Query Parameters

account_id
string

The ID of the account, which will look like biz_*************. Optional for account API keys; required for credentials that can access multiple accounts.

from
integer

Start of the time range as a Unix timestamp. Defaults to 366 days before to.

to
integer

End of the time range as a Unix timestamp. Defaults to now.

first
integer

The number of people to return (default 100, max 101).

offset
integer

The number of people to skip, for offset pagination.

sort
string

Column to sort by (e.g. last_seen_at, ltv, purchase_count). Defaults to last_seen_at.

direction
enum<string>

Sort direction. Defaults to desc.

Available options:
asc,
desc
filters
string

A JSON-encoded array of filters, each with field, operator, and value keys.

Response

people listed

data
object[]
required
total_count
integer
required