Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-10"

Query Parameters

account_id
string

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

query
string

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

source
string[]

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

attribution_model
enum<string>

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

Available options:
last_touch,
first_touch
event_name
string[]

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

custom_event
string

Only include people who fired this custom pixel event.

event_from
string<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_to
string<date-time>

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

audience_id
string

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_id
string

Only include the person linked to this whop user ID.

email
string

Only include the person linked to this email address.

phone
string

Only include the person linked to this phone number.

country
string

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

has_purchased
boolean

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

contactable
boolean

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

first_seen_within_days
integer

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

last_seen_within_days
integer

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

first_seen_after
string<date-time>

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

first_seen_before
string<date-time>

Only include people first seen before this ISO 8601 timestamp.

last_seen_after
string<date-time>

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

last_seen_before
string<date-time>

Only include people last seen before this ISO 8601 timestamp.

first
integer

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

after
string

A cursor for fetching people after a previous page.

before
string

A cursor for fetching people before a later page.

order
enum<string>

Column to sort by. Defaults to last_seen_at.

Available options:
first_seen_at,
last_seen_at,
first_purchase_at,
last_purchase_at,
purchase_count,
event_count,
ltv,
aov,
name,
email
direction
enum<string>

Sort direction. Defaults to desc.

Available options:
asc,
desc

Response

people listed

data
object[]
required
page_info
object
required
total_count
integer