Skip to main content
A User represents a person on Whop. Users have a public profile and can buy products, join accounts, and access experiences. Use the Users API to search for users, retrieve or update profiles, and check whether a user has access to an account, product, or experience.

Endpoints

Attributes

id
string
required
User ID, prefixed user_.
balance
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

businesses
object[]
required
Account balances for accounts the user owns, highest balance first. Excludes accounts with no balance.

Properties

id
string
required
The account ID, which looks like biz_*************.
balance_usd
string
required
The account’s total balance in USD.
logo_url
string | null
required
The account’s logo URL.
name
string | null
required
The account’s display name.
businesses_total_usd
string
required
Combined USD balance across every account the user owns.
cash
object[]
required
Per-currency fiat cash balances.

Properties

balance
number
required
Available balance in the native currency.
balance_usd
number
required
Available balance converted to USD.
currency
string
required
Lowercase ISO currency code, such as usd or eur.
pending_balance_usd
number
required
Pending balance converted to USD.
reserve_balance_usd
number
required
Reserved balance converted to USD.
total_withdrawable_balance
number
required
Withdrawable amount in the native currency.
cash_usd
string
required
Fiat cash in USD, including pending and reserve.
crypto
object[]
required
Per-token crypto holdings in the ledger’s own wallet.

Properties

balance
string
required
Amount held in native token units, as a decimal string.
icon_url
string | null
required
Token icon URL.
name
string | null
required
The token’s display name.
price_usd
number | null
required
USD price per token, or null when unknown.
symbol
string
required
Token display symbol, such as USDT, XAUT, or cbBTC.
value_usd
number
required
Holding USD value.
crypto_usd
string
required
Crypto holdings in USD.
pending_usd
string
required
Pending funds in USD: fiat pending + in-flight treasury deposits.
total_usd
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).
treasury_pending_usd
string
required
Balance-to-wallet USDT0 withdrawals still in flight, in USD.
balance_history
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

data
object[]
required
Cumulative balance points over the requested window, oldest first.

Properties

t
integer
required
Point timestamp, in Unix seconds.
v
number
required
Cumulative wallet balance at this point, in USD.
last
number
required
Value of the most recent point, in USD.
max
number
required
Maximum value across the window, in USD.
min
number
required
Minimum value across the window, in USD.
bio
string | null
required
The user’s biography
created_at
string
required
When the user was created, as an ISO 8601 timestamp
earnings_usd
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

first_earned_at
string | null
required
The first time the user earned gross income, as an ISO 8601 timestamp.
owned_accounts
object
required
Gross income from accounts the user owns or is owner-authorized on.

Properties

last_24_hours
string
required
Gross income in USD over the last 24 hours.
last_30_days
string
required
Gross income in USD over the last 30 days.
last_7_days
string
required
Gross income in USD over the last 7 days.
lifetime
string
required
All-time gross income in USD.
personal
object
required
Gross income from the user’s personal wallet.

Properties

last_24_hours
string
required
Gross income in USD over the last 24 hours.
last_30_days
string
required
Gross income in USD over the last 30 days.
last_7_days
string
required
Gross income in USD over the last 7 days.
lifetime
string
required
All-time gross income in USD.
total
object
required
Gross income from the user’s personal wallet plus accounts they own or are owner-authorized on.

Properties

last_24_hours
string
required
Gross income in USD over the last 24 hours.
last_30_days
string
required
Gross income in USD over the last 30 days.
last_7_days
string
required
Gross income in USD over the last 7 days.
lifetime
string
required
All-time gross income in USD.
name
string | null
required
The user’s display name
profile_picture
object | null
required
The user’s profile picture, an object with a url
username
string
required
The user’s unique username
verification
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.
whop_partner_enabled_at
string | null
required
When the user became an enrolled Whop Partner, as an ISO 8601 timestamp. null if never enrolled.
User