> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # User 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 | Endpoint | Request | | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- | | [List Users](/api-reference/beta/users/list-users) | GET `/users` | | [Retrieve User](/api-reference/beta/users/retrieve-user) | GET `/users/{id}` | | [Update User](/api-reference/beta/users/update-user) | PATCH `/users/{id}` | | [Check User Access](/api-reference/beta/users/check-user-access) | GET `/users/{id}/access/{resource_id}` | | [List Recommended Actions](/api-reference/beta/users/list-recommended-actions) | GET `/users/{id}/recommend_actions` | | [List OAuth Grants](/api-reference/beta/users/list-oauth-grants) | GET `/users/me/oauth_grants` | | [Authorize an App](/api-reference/beta/users/authorize-an-app) | POST `/users/me/oauth_grants` | | [List](/api-reference/beta/users/list) | GET `/users/me/passkeys` | | [Register](/api-reference/beta/users/register) | POST `/users/me/passkeys` | | [Delete](/api-reference/beta/users/delete) | DELETE `/users/me/passkeys/{id}` | | [Create Challenge](/api-reference/beta/users/create-challenge) | POST `/users/me/passkeys/challenge` | | [Retrieve](/api-reference/beta/users/retrieve) | GET `/users/me/preferences` | | [Update](/api-reference/beta/users/update) | PATCH `/users/me/preferences` | | [Set](/api-reference/beta/users/set) | PATCH `/users/me/preferences/notifications` | | [List Experiences](/api-reference/beta/users/list-experiences) | GET `/users/me/preferences/notifications/experiences` | | [List Topics](/api-reference/beta/users/list-topics) | GET `/users/me/preferences/notifications/topics` | ## Attributes User ID, prefixed `user_`. The user's balance: personal cash + crypto + in-flight treasury deposits, plus account balances for accounts they own. Computed only on the self view (retrieved with the reserved id `me`) for callers with balance-read scope; `null` otherwise. Account balances for accounts the user owns, highest balance first. Excludes accounts with no balance. The account ID, which looks like biz\_\*\*\*\*\*\*\*\*\*\*\*\*\*. The account's total balance in USD. The account's logo URL. The account's display name. Combined USD balance across every account the user owns. Per-currency fiat cash balances. Available balance in the native currency. Available balance converted to USD. Lowercase ISO currency code, such as `usd` or `eur`. Balance moving to the user's own wallet or card, converted to USD. Pending balance converted to USD. USD price per native currency unit, or `null` when no exchange rate is available. Reserved balance converted to USD. Withdrawable amount in the native currency. Fiat cash in USD, including pending, in-transit, and reserve. Per-token crypto holdings in the ledger's own wallet. Amount held in native token units, as a decimal string. Balance split into available, pending, in-transit, and reserve amounts, as native-unit decimal strings. Transfers between the user's own wallet and card are reported in `in_transit` until they arrive. Amount you can spend, send, or withdraw now, in native units, as a decimal string. Amount moving between the account's own destinations, such as a treasury sweep to its crypto wallet or a card top-up. In native units, as a decimal string. Amount from recent payments still settling, in native units, as a decimal string. When the pending amount is expected to settle, one entry per day, earliest first. Money with no scheduled settlement day, such as a transfer in flight, is left out — so these can sum to less than `pending`, never more. Amount expected that day, in native units, as a decimal string. The day this money is expected to finish settling, as an ISO 8601 date. Amount held back, in native units, as a decimal string. Retrieve the account's reserves for why it is held and when it unlocks. Token icon URL. The token's display name. USD price per token, or `null` when unknown. Token display symbol, such as `USDT`, `XAUT`, or `cbBTC`. Holding USD value. Crypto holdings in USD. Fiat pending and in-transit balances, plus in-flight treasury deposits, in USD. The user's personal balance in USD: cash (available + pending + in-transit + reserve) + crypto + in-flight treasury deposits. Excludes account balances (see businesses\_total\_usd). Balance-to-wallet USDT0 withdrawals still in flight, in USD. 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` when retrieving yourself with the reserved id `me`; populated only for callers with balance-read scope and `null` otherwise. A user with no wallet activity returns an empty series. Cumulative balance points over the requested window, oldest first. Point timestamp, in Unix seconds. Cumulative wallet balance at this point, in USD. Value of the most recent point, in USD. Maximum value across the window, in USD. Minimum value across the window, in USD. The user's profile banner wrapper. `null` when the user has no banner. Profile banner image URL. The user's biography When the user was created, as an ISO 8601 timestamp The user's gross USD income over time. Populated only on single-user self reads for callers with balance-read scope; `null` otherwise. The first time the user earned gross income, as an ISO 8601 timestamp. Gross income from accounts the user owns or is owner-authorized on. Gross income in USD over the last 24 hours. Gross income in USD over the last 30 days. Gross income in USD over the last 7 days. All-time gross income in USD. Gross income from the user's personal wallet. Gross income in USD over the last 24 hours. Gross income in USD over the last 30 days. Gross income in USD over the last 7 days. All-time gross income in USD. Gross income from the user's personal wallet plus accounts they own or are owner-authorized on. Gross income in USD over the last 24 hours. Gross income in USD over the last 30 days. Gross income in USD over the last 7 days. All-time gross income in USD. The user's email address. Populated only on the self view (retrieved with the reserved id `me`) for callers with email-read scope; `null` otherwise, or while the account has no confirmed email yet. The user's display name Avatar wrapper; its `url` is always present, using a generated placeholder when the user set no picture. Avatar image URL. Always present — a generated placeholder when the user set no picture. 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. Unique identifier for the social account. 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. The platform-specific ID for this social account. The display name of the social account on the platform. The social account this one belongs to on the platform, such as the Facebook page that owns an Instagram account. Null when the social account stands on its own. Social account ID, prefixed `sacc_`. The platform-specific ID for the parent social account. The display name of the parent social account on the platform. The platform the parent social account exists on. Available options: `x`, `instagram`, `youtube`, `tiktok`, `facebook`, `discord`, `telegram` The URL where the profile picture of the parent social account can be accessed. The username of the parent social account on the platform. Whether the parent social account is verified on the platform. The platform the social account exists on. Available options: `x`, `instagram`, `youtube`, `tiktok`, `facebook`, `discord`, `telegram` The URL where the profile picture of the social account can be accessed. 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. The URL where the social account can be accessed on the platform. Null while a Whop-owned page is still being provisioned. The username of the social account on the platform. Null while a Whop-owned page is still being provisioned. Whether the social account is verified on the platform. Whop staff access flags. Populated only on the self view (retrieved with the reserved id `me`) for callers with staff-read scope; `null` there for every user who is not Whop staff, and always `null` elsewhere. Whether the user holds the admin staff role with a valid second factor. Whether the user can open Whop-internal investigation tooling right now: a qualifying staff role plus their investigation toggle switched on. Whether the user holds the manager staff role with a valid second factor. Whether the user holds the support staff role with a valid second factor. The user's unique username 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`. When the user became an enrolled Whop Partner, as an ISO 8601 timestamp. `null` if never enrolled.
```json User theme={null} { "id": "user_alex123", "balance": { "businesses": [ { "id": "biz_acme123", "name": "Acme Inc", "logo_url": "https://cdn.whop.com/logos/acme.png", "balance_usd": "14325.00" } ], "businesses_total_usd": "14325.00", "cash": [ { "currency": "usd", "balance": 250, "balance_usd": 250, "pending_balance_usd": 0, "in_transit_balance_usd": 0, "price_usd": 1, "reserve_balance_usd": 0, "total_withdrawable_balance": 250 } ], "cash_usd": "250.00", "crypto": [ { "symbol": "USDT", "name": "Tether USD", "balance": "500.00", "breakdown": { "available": "450.00", "in_transit": "0", "pending": "50.00", "pending_settlements": [ { "amount": "50.00", "date": "2026-08-12" } ], "reserve": "0" }, "value_usd": 500, "price_usd": 1, "icon_url": "https://cdn.whop.com/tokens/usdt.png" } ], "crypto_usd": "500.00", "pending_usd": "0.00", "total_usd": "750.00", "treasury_pending_usd": "0.00" }, "balance_history": { "data": [ { "t": 1735689600, "v": 500 }, { "t": 1735776000, "v": 750 } ], "last": 750, "min": 500, "max": 750 }, "bio": "Building communities on Whop.", "banner": { "url": "https://cdn.whop.com/banner.png" }, "social_accounts": [ { "id": "discord_123456789012345678", "platform": "discord", "username": "alex", "name": "alex", "url": null, "profile_picture_url": "https://cdn.discordapp.com/avatars/123456789012345678/abcdef.png", "verified": false, "external_id": "123456789012345678", "scopes": [], "error": null, "parent_social_account": null }, { "id": "telegram_987654321", "platform": "telegram", "username": "alex_tg", "name": "alex_tg", "url": null, "profile_picture_url": null, "verified": false, "external_id": "987654321", "scopes": [], "error": null, "parent_social_account": null }, { "id": "x_111222333", "platform": "x", "username": "alex", "name": "alex", "url": null, "profile_picture_url": "https://pbs.twimg.com/profile_images/alex.jpg", "verified": true, "external_id": "111222333", "scopes": [], "error": null, "parent_social_account": null } ], "created_at": "2026-06-01T12:00:00Z", "earnings_usd": { "total": { "lifetime": "15075.00", "last_30_days": "3425.00", "last_7_days": "890.00", "last_24_hours": "120.00" }, "personal": { "lifetime": "750.00", "last_30_days": "250.00", "last_7_days": "100.00", "last_24_hours": "25.00" }, "owned_accounts": { "lifetime": "14325.00", "last_30_days": "3175.00", "last_7_days": "790.00", "last_24_hours": "95.00" }, "first_earned_at": "2026-06-02T15:30:00Z" }, "name": "Alex Rivera", "profile_picture": { "url": "https://cdn.whop.com/avatar.png" }, "username": "alex", "verification": { "business": null, "individual": { "status": "approved" } }, "whop_partner_enabled_at": "2026-06-10T09:00:00Z", "email": "jack@whop.com", "staff": null } ```