Skip to main content
GET
TypeScript

Autorisaties

Authorization
string
header
vereist

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

company:basic:read
member:basic:read
member:journey:read

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Queryparameters

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).

Beschikbare opties:
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_within_days
integer

Match activity within a rolling number of days. Cannot be combined with event_from/event_to.

Vereist bereik: x >= 1
from
string<date-time>

Inclusive activity-window start. Alias for event_from.

to
string<date-time>

Inclusive activity-window end. Alias for event_to.

event_from
string<date-time>

The inclusive start of the matching activity window.

event_to
string<date-time>

The inclusive end of the matching activity window, for both stats drilldowns and saved audiences.

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 with activity 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.

ltv_gt
number

Select people whose lifetime ltv is greater than this value. LTV and AOV are in USD.

ltv_gte
number

Select people whose lifetime ltv is at least this value. LTV and AOV are in USD.

ltv_lt
number

Select people whose lifetime ltv is less than this value. LTV and AOV are in USD.

ltv_lte
number

Select people whose lifetime ltv is at most this value. LTV and AOV are in USD.

aov_gt
number

Select people whose lifetime aov is greater than this value. LTV and AOV are in USD.

aov_gte
number

Select people whose lifetime aov is at least this value. LTV and AOV are in USD.

aov_lt
number

Select people whose lifetime aov is less than this value. LTV and AOV are in USD.

aov_lte
number

Select people whose lifetime aov is at most this value. LTV and AOV are in USD.

purchase_count_gt
number

Select people whose lifetime purchase_count is greater than this value. LTV and AOV are in USD.

purchase_count_gte
number

Select people whose lifetime purchase_count is at least this value. LTV and AOV are in USD.

purchase_count_lt
number

Select people whose lifetime purchase_count is less than this value. LTV and AOV are in USD.

purchase_count_lte
number

Select people whose lifetime purchase_count is at most this value. LTV and AOV are in USD.

event_count_gt
number

Select people whose lifetime event_count is greater than this value. LTV and AOV are in USD.

event_count_gte
number

Select people whose lifetime event_count is at least this value. LTV and AOV are in USD.

event_count_lt
number

Select people whose lifetime event_count is less than this value. LTV and AOV are in USD.

event_count_lte
number

Select people whose lifetime event_count is at most this value. LTV and AOV are in USD.

first
integer
standaard:100

Number of results to return from the start of the range.

Vereist bereik: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

order
enum<string>

Column to sort by. Defaults to last_seen_at.

Beschikbare opties:
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.

Beschikbare opties:
asc,
desc

Respons

people listed

data
object[]
vereist
page_info
object
vereist
total_count
integer
Voorbeeld:

42