Sign in
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.

[
  "direct"
]
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.

[
  "payment.completed"
]
custom_eventstring

Only include people who fired this custom pixel event.

event_within_daysinteger

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

fromstring date-time

Inclusive activity-window start. Alias for event_from.

tostring date-time

Inclusive activity-window end. Alias for event_to.

event_fromstring date-time

The inclusive start of the matching activity window.

event_tostring date-time

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

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

ltv_gtnumber

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

ltv_gtenumber

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

ltv_ltnumber

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

ltv_ltenumber

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

aov_gtnumber

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

aov_gtenumber

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

aov_ltnumber

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

aov_ltenumber

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

purchase_count_gtnumber

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

purchase_count_gtenumber

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

purchase_count_ltnumber

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

purchase_count_ltenumber

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

event_count_gtnumber

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

event_count_gtenumber

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

event_count_ltnumber

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

event_count_ltenumber

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

firstinteger

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

afterstring

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

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous 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-09-25

Pins the request to a dated API version.

Response

people listed

total_countinteger

Example response

{
  "data": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "aov": 74.99,
      "device": {
        "browser": "Dana Whitfield",
        "device": "Dana Whitfield",
        "os": "Dana Whitfield"
      },
      "email": "marcus@shinetime.example",
      "event_count": 42,
      "first_purchase_at": "2026-01-01T12:00:00.000Z",
      "first_seen_at": "2026-01-01T12:00:00.000Z",
      "first_source": {
        "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",
        "type": "ad_click",
        "utm_source": "Dana Whitfield"
      },
      "id": "prsn_123",
      "last_ip": "Dana Whitfield",
      "last_purchase_at": "2026-01-01T12:00:00.000Z",
      "last_seen_at": "2026-01-01T12:00:00.000Z",
      "last_source": {
        "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",
        "type": "ad_click",
        "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",
      "purchase_count": 2,
      "timezone": "Dana Whitfield",
      "user": {
        "id": "user_dana1",
        "name": "Dana Whitfield",
        "profile_pic_url": "Dana Whitfield",
        "username": "danawhitfield"
      }
    }
  ],
  "page_info": {
    "end_cursor": "cursor_end",
    "start_cursor": "cursor_start"
  },
  "total_count": 42
}

Changes

Changed in 65 of the 74 revisions of this API.49183

  • 78e1ed7366cd2See the full diff
    • ○

      the security scope company:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope member:journey:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 73dd0533cd812See the full diff
    • ○

      the security scope company:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope member:journey:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 86b97292852d2See the full diff
    • ○

      the security scope company:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope member:journey:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • c1dceb26e5052See the full diff
    • ○

      the security scope company:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope member:journey:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 7fcefabddb0a2See the full diff
    • ○

      the security scope company:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope member:journey:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 140d015b99662See the full diff
    • ○

      the security scope company:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope member:journey:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 35edb053220a2See the full diff
    • ○

      the security scope company:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope member:journey:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ac2b9b1c6a002See the full diff
    • ○

      the security scope company:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope member:journey:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • a88353507eac21See the full diff
    • ○

      the security scope company:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope member:journey:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

    • ○

      added the new optional query request parameter aov_gt

      new-optional-request-parameter

    • ○

      added the new optional query request parameter aov_gte

      new-optional-request-parameter

    • ○

      added the new optional query request parameter aov_lt

      new-optional-request-parameter

    • ○

      added the new optional query request parameter aov_lte

      new-optional-request-parameter

    • ○

      added the new optional query request parameter event_count_gt

      new-optional-request-parameter

    • ○

      added the new optional query request parameter event_count_gte

      new-optional-request-parameter

    • ○

      added the new optional query request parameter event_count_lt

      new-optional-request-parameter

    • ○

      added the new optional query request parameter event_count_lte

      new-optional-request-parameter

    • ○

      added the new optional query request parameter event_within_days

      new-optional-request-parameter

    • ○

      added the new optional query request parameter from

      new-optional-request-parameter

    • ○

      added the new optional query request parameter ltv_gt

      new-optional-request-parameter

    • ○

      added the new optional query request parameter ltv_gte

      new-optional-request-parameter

    • ○

      added the new optional query request parameter ltv_lt

      new-optional-request-parameter

    • ○

      added the new optional query request parameter ltv_lte

      new-optional-request-parameter

    • ○

      added the new optional query request parameter purchase_count_gt

      new-optional-request-parameter

    • ○

      added the new optional query request parameter purchase_count_gte

      new-optional-request-parameter

    • ○

      added the new optional query request parameter purchase_count_lt

      new-optional-request-parameter

    • ○

      added the new optional query request parameter purchase_count_lte

      new-optional-request-parameter

    • ○

      added the new optional query request parameter to

      new-optional-request-parameter

  • 51933d70d7f52See the full diff
    • ○

      the security scope company:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope member:journey:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

Of the 74 revisions, 1 has no diff computed.