Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-22"

Query Parameters

account_id
string

When set, returns your account-specific profile overrides for this account.

include_balance_history
boolean

Also compute your balance history (opt-in; runs a heavier query). Ignored for callers without balance-read scope.

from
string

Balance-history window start, ISO 8601 date or datetime. Defaults to 30 days ago. Only used with include_balance_history.

to
string

Balance-history window end, ISO 8601 date or datetime. Defaults to now. Only used with include_balance_history.

interval
enum<string>

Balance-history point granularity. Defaults to day. Only used with include_balance_history.

Available options:
hour,
day,
week,
month
time_zone
string

IANA time zone the balance-history points are bucketed in. Defaults to UTC. Only used with include_balance_history.

Response

current user retrieved

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.

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.

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.

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

id
string
required

User ID, prefixed user_.

name
string | null
required

The user's display name

profile_picture
object | null
required

The user's profile picture, an object with a url

social_accounts
object[]
required
staff
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.

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.