v8

OpenAPI 3.1.02026-08-033623795.0 MB

Users

Retrieve Current User

Retrieves the authenticated user — the self view of the user object. Same shape as GET /users/{id}, with the self-only fields populated: email (email-read scope), staff (Whop staff only, staff-read scope), balance and earnings_usd (balance-read scope), the opt-in balance_history, and every linked social account.

get/users/me

Query parameters

account_idstring

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

include_balance_historyboolean

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

fromstring

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

tostring

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

interval'hour' | 'day' | 'week' | 'month'

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

time_zonestring

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

Response

current user retrieved

biostring nullable required

The user's biography

created_atstring required

When the user was created, as an ISO 8601 timestamp

emailstring nullable 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.

idstring required

User ID, prefixed user_.

namestring nullable required

The user's display name

profile_pictureobject nullable required

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

usernamestring required

The user's unique username

verificationobject 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_atstring nullable required

When the user became an enrolled Whop Partner, as an ISO 8601 timestamp. null if never enrolled.

Example response

{
  "social_accounts": [
    {
      "platform": "x"
    }
  ]
}