v8

OpenAPI 3.1.02026-08-033623795.0 MB
People

List People

Lists the people (visitors and customers) of an account: the identity-linked person profiles aggregated from every pixel, payment, and platform event — identities, purchases and LTV, geo/device profile, traffic sources, and first/last marketing touches.

get/people

Query parameters

account_idstring

Account ID, prefixed biz_. Optional for account API keys; required for credentials that can access multiple accounts.

querystring

Search people by name, email, phone, or whop user ID (case-insensitive substring match).

sourcestring[]

Only include people acquired from any of these sources — canonical paths (whop:<campaign>:<group>:<ad>, ext:<platform>:..., referrer:<domain>, direct, other), exact or with a trailing :* prefix. The same vocabulary the events / people metrics use.

attribution_model'last_touch' | 'first_touch'

Attribution model the source filter matches against (defaults to last_touch).

event_namestring[]

Only include people who fired any of these events, e.g. payment.completed or page.checkout.view.

custom_eventstring

Only include people who fired this custom pixel event.

event_fromstring date-time

With event_to plus an event or source filter, switches to exact-population mode: person ids are resolved and paginated on the events side within this window (the same query the people metric counts), then hydrated per page.

event_tostring date-time

The inclusive end of the event window for exact-population mode.

audience_idstring

Only include people in this audience. An audience that keeps itself up to date resolves to the People filters that define it, so this always reflects who matches now; uploaded lists and point-in-time snapshots match their recorded members.

user_idstring

Only include the person linked to this whop user ID.

emailstring

Only include the person linked to this email address.

phonestring

Only include the person linked to this phone number.

countrystring

Only include people whose most recent visit came from this ISO 3166-1 alpha-2 country code.

has_purchasedboolean

true for customers only, false for people who have never purchased.

contactableboolean

true for people who have an email address or phone number — the ones an ad platform can match.

first_seen_within_daysinteger

Only include people first seen within this many days, as a rolling window.

last_seen_within_daysinteger

Only include people last seen within this many days, as a rolling window.

first_seen_afterstring date-time

Only include people first seen at or after this ISO 8601 timestamp.

first_seen_beforestring date-time

Only include people first seen before this ISO 8601 timestamp.

last_seen_afterstring date-time

Only include people last seen at or after this ISO 8601 timestamp.

last_seen_beforestring date-time

Only include people last seen before this ISO 8601 timestamp.

firstinteger

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

afterstring

A cursor for fetching people after a previous page.

beforestring

A cursor for fetching people before a later page.

order'first_seen_at' | 'last_seen_at' | 'first_purchase_at' | 'last_purchase_at' | 'purchase_count' | 'event_count' | 'ltv' | 'aov' | 'name' | 'email'

Column to sort by. Defaults to last_seen_at.

direction'asc' | 'desc'

Sort direction. Defaults to desc.

Headers

Api-Version-Datestring
Example:2026-07-31

Pins the request to a dated API version.

Response

people listed

total_countinteger