Endpoints
Attributes
string
required
User ID, prefixed
user_.object | null
required
The user’s balance: personal cash + crypto + in-flight treasury deposits, plus account balances for accounts they own. Computed only on
GET /users/me self-view for callers with balance-read scope; null otherwise.Properties
Properties
object[]
required
Account balances for accounts the user owns, highest balance first. Excludes accounts with no balance.
string
required
Combined USD balance across every account the user owns.
object[]
required
Per-currency fiat cash balances.
Properties
Properties
number
required
Available balance in the native currency.
number
required
Available balance converted to USD.
string
required
Lowercase ISO currency code, such as
usd or eur.number
required
Pending balance converted to USD.
number
required
Reserved balance converted to USD.
number
required
Withdrawable amount in the native currency.
string
required
Fiat cash in USD, including pending and reserve.
object[]
required
Per-token crypto holdings in the ledger’s own wallet.
Properties
Properties
string
required
Amount held in native token units, as a decimal string.
string | null
required
Token icon URL.
string | null
required
The token’s display name.
number | null
required
USD price per token, or
null when unknown.string
required
Token display symbol, such as
USDT, XAUT, or cbBTC.number
required
Holding USD value.
string
required
Crypto holdings in USD.
string
required
Pending funds in USD: fiat pending + in-flight treasury deposits.
string
required
The user’s personal balance in USD: cash (available + pending + reserve) +
crypto + in-flight treasury deposits. Excludes account balances (see
businesses_total_usd).
string
required
Balance-to-wallet USDT0 withdrawals still in flight, in USD.
object | null
required
The user’s cumulative wallet balance over time (USD
\{ t, v } points plus last/min/max), for the balance chart. Opt in with include_balance_history=true on GET /users/me; populated only for callers with balance-read scope and null otherwise. A user with no wallet activity returns an empty series.Properties
Properties
object[]
required
number
required
Value of the most recent point, in USD.
number
required
Maximum value across the window, in USD.
number
required
Minimum value across the window, in USD.
string | null
required
The user’s biography
string
required
When the user was created, as an ISO 8601 timestamp
object | null
required
The user’s gross USD income over time. Populated only on single-user self reads for callers with balance-read scope;
null otherwise.Properties
Properties
string | null
required
The first time the user earned gross income, as an ISO 8601 timestamp.
object
required
object
required
object
required
Gross income from the user’s personal wallet plus accounts they own or are owner-authorized on.
string | null
required
The user’s email address. Populated only on
GET /users/me self-view for
callers with email-read scope; null otherwise, or while the account has no
confirmed email yet.string | null
required
The user’s display name
object | null
required
The user’s profile picture, an object with a url
object[]
required
Social accounts linked to the user (Discord, X/Twitter, Telegram), oldest first. Reading your own profile returns every linked account; other profiles only include what is public on Whop (the primary Discord and the X account). Empty when none are linked.
Properties
Properties
string
required
Unique identifier for the social account.
string | null
required
Why this social account currently can’t be used for advertising — a failed
share or a Meta-side restriction. Null when the account is healthy.
string | null
required
The platform-specific ID for this social account.
string | null
required
The display name of the social account on the platform.
string
required
The platform the social account exists on.Available options:
x, instagram, youtube, tiktok, facebook, discord, telegramstring | null
required
The URL where the profile picture of the social account can be accessed.
string[]
required
Capabilities Whop retains specific to this social account. For example, Whop
may request the ability to run advertisements that use this social account’s
identity, reflected by the presence of
advertise in this value.string | null
required
The URL where the social account can be accessed on the platform. Null while a
Whop-owned page is still being provisioned.
string | null
required
The username of the social account on the platform. Null while a Whop-owned
page is still being provisioned.
boolean
required
Whether the social account is verified on the platform.
object | null
required
Whop staff access flags. Populated only on
GET /users/me self-view for callers with staff-read scope; null there for every user who is not Whop staff, and always null elsewhere.Properties
Properties
boolean
required
Whether the user holds the admin staff role with a valid second factor.
boolean
required
Whether the user can open Whop-internal investigation tooling right now: a
qualifying staff role plus their investigation toggle switched on.
boolean
required
Whether the user holds the manager staff role with a valid second factor.
boolean
required
Whether the user holds the support staff role with a valid second factor.
string
required
The user’s unique username
object
required
Identity verification status for the user’s
individual (KYC) and business
(KYB) profiles. Each is null until created, otherwise a status of
not_started, pending, approved, or rejected.string | null
required
When the user became an enrolled Whop Partner, as an ISO 8601 timestamp.
null if never enrolled.User