List People

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.people.list({
    source: ["direct"],
    event_name: ["payment.completed"]
});

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/people', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/people",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/people"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/people")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "event_count": 42,
      "first_seen_at": "2026-01-01T12:00:00.000Z",
      "id": "prsn_123",
      "last_seen_at": "2026-01-01T12:00:00.000Z",
      "purchase_count": 2,
      "aov": 74.99,
      "device": {
        "browser": "Dana Whitfield",
        "device": "Dana Whitfield",
        "os": "Dana Whitfield"
      },
      "email": "marcus@shinetime.example",
      "first_purchase_at": "2026-01-01T12:00:00.000Z",
      "first_source": {
        "type": "ad_click",
        "ad": {
          "id": "adcamp_1",
          "name": "Dana Whitfield",
          "thumbnail_url": "Dana Whitfield"
        },
        "ad_group": {
          "id": "adcamp_1",
          "name": "Dana Whitfield",
          "thumbnail_url": "Dana Whitfield"
        },
        "campaign": {
          "id": "adcamp_1",
          "name": "Dana Whitfield",
          "thumbnail_url": "Dana Whitfield"
        },
        "domain": "Dana Whitfield",
        "occurred_at": "2026-01-01T12:00:00.000Z",
        "platform": "Dana Whitfield",
        "utm_source": "Dana Whitfield"
      },
      "last_ip": "Dana Whitfield",
      "last_purchase_at": "2026-01-01T12:00:00.000Z",
      "last_source": {
        "type": "ad_click",
        "ad": {
          "id": "adcamp_1",
          "name": "Dana Whitfield",
          "thumbnail_url": "Dana Whitfield"
        },
        "ad_group": {
          "id": "adcamp_1",
          "name": "Dana Whitfield",
          "thumbnail_url": "Dana Whitfield"
        },
        "campaign": {
          "id": "adcamp_1",
          "name": "Dana Whitfield",
          "thumbnail_url": "Dana Whitfield"
        },
        "domain": "Dana Whitfield",
        "occurred_at": "2026-01-01T12:00:00.000Z",
        "platform": "Dana Whitfield",
        "utm_source": "Dana Whitfield"
      },
      "location": {
        "city": "Dana Whitfield",
        "continent": "Dana Whitfield",
        "country": "Dana Whitfield"
      },
      "ltv": 149.98,
      "member": {
        "id": "mem_dana1",
        "joined_at": "2026-01-01T12:00:00.000Z",
        "status": "Dana Whitfield",
        "usd_total_spend": 149.98
      },
      "name": "Dana Whitfield",
      "phone": "+xxxxxxxxxxx",
      "timezone": "Dana Whitfield",
      "user": {
        "id": "user_dana1",
        "username": "danawhitfield",
        "name": "Dana Whitfield",
        "profile_pic_url": "Dana Whitfield"
      }
    }
  ],
  "page_info": {
    "has_next_page": false,
    "has_previous_page": false,
    "end_cursor": "cursor_end",
    "start_cursor": "cursor_start"
  },
  "total_count": 42
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

GET

people

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.people.list({
    source: ["direct"],
    event_name: ["payment.completed"]
});

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/people', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/people",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/people"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/people")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "event_count": 42,
      "first_seen_at": "2026-01-01T12:00:00.000Z",
      "id": "prsn_123",
      "last_seen_at": "2026-01-01T12:00:00.000Z",
      "purchase_count": 2,
      "aov": 74.99,
      "device": {
        "browser": "Dana Whitfield",
        "device": "Dana Whitfield",
        "os": "Dana Whitfield"
      },
      "email": "marcus@shinetime.example",
      "first_purchase_at": "2026-01-01T12:00:00.000Z",
      "first_source": {
        "type": "ad_click",
        "ad": {
          "id": "adcamp_1",
          "name": "Dana Whitfield",
          "thumbnail_url": "Dana Whitfield"
        },
        "ad_group": {
          "id": "adcamp_1",
          "name": "Dana Whitfield",
          "thumbnail_url": "Dana Whitfield"
        },
        "campaign": {
          "id": "adcamp_1",
          "name": "Dana Whitfield",
          "thumbnail_url": "Dana Whitfield"
        },
        "domain": "Dana Whitfield",
        "occurred_at": "2026-01-01T12:00:00.000Z",
        "platform": "Dana Whitfield",
        "utm_source": "Dana Whitfield"
      },
      "last_ip": "Dana Whitfield",
      "last_purchase_at": "2026-01-01T12:00:00.000Z",
      "last_source": {
        "type": "ad_click",
        "ad": {
          "id": "adcamp_1",
          "name": "Dana Whitfield",
          "thumbnail_url": "Dana Whitfield"
        },
        "ad_group": {
          "id": "adcamp_1",
          "name": "Dana Whitfield",
          "thumbnail_url": "Dana Whitfield"
        },
        "campaign": {
          "id": "adcamp_1",
          "name": "Dana Whitfield",
          "thumbnail_url": "Dana Whitfield"
        },
        "domain": "Dana Whitfield",
        "occurred_at": "2026-01-01T12:00:00.000Z",
        "platform": "Dana Whitfield",
        "utm_source": "Dana Whitfield"
      },
      "location": {
        "city": "Dana Whitfield",
        "continent": "Dana Whitfield",
        "country": "Dana Whitfield"
      },
      "ltv": 149.98,
      "member": {
        "id": "mem_dana1",
        "joined_at": "2026-01-01T12:00:00.000Z",
        "status": "Dana Whitfield",
        "usd_total_spend": 149.98
      },
      "name": "Dana Whitfield",
      "phone": "+xxxxxxxxxxx",
      "timezone": "Dana Whitfield",
      "user": {
        "id": "user_dana1",
        "username": "danawhitfield",
        "name": "Dana Whitfield",
        "profile_pic_url": "Dana Whitfield"
      }
    }
  ],
  "page_info": {
    "has_next_page": false,
    "has_previous_page": false,
    "end_cursor": "cursor_end",
    "start_cursor": "cursor_start"
  },
  "total_count": 42
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

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-09-15"

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_within_days

integer

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

Required range: x >= 1

from

string<date-time>

Inclusive activity-window start. Alias for event_from.

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.

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

default:100

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

Required range: 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.

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

Show child attributes

page_info

object

required

Show child attributes

total_count

integer

Example:

42

Introduction

Reference

Webhooks & Events

Core Resources

Notifications

Payments

Money

Commerce

Partners

Workforce

Tracking

Ads

Media

Identity

Developer

Authorizations

Headers

Query Parameters

Response