> ## 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. # 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. ## OpenAPI ````yaml /openapi/api-v1-native.json get /users/me openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: '2026-07-22' servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: > An Account represents a person or business on Whop that can have its own profile, wallet, and account-scoped settings. Use accounts for customers, creators, merchants, sellers, or connected businesses your integration supports. Use the Accounts API to create accounts, list accounts visible to your credentials, retrieve or update an account, and retrieve the account associated with the current API key. name: Accounts x-whop-summary: 'A business on Whop: profile, wallet, capabilities, settings.' - description: > 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. name: Users x-whop-summary: 'A person on Whop: profile and connected identities.' - description: > A Team Member is a member of an account's team: the link between a user and an account, carrying the role that controls what they can do. Roles are either system roles (like `admin` or `moderator`) or `custom` roles managed from the dashboard. Use the Team Members API to list an account's team, add a user to the team with a system role, change a member's role, and remove members. Adding a user who has not yet accepted sends an invitation instead. name: Team Members x-whop-summary: An account's team members and the roles that scope their access. - name: Webhooks x-whop-summary: Event notifications pushed to your server as things happen. - description: > Stats represent aggregated activity for an account over time. They help you understand revenue, transactions, disputes, members, referrals, and advertising performance across reporting periods like days, weeks, or months. Use the Stats API to list available metrics and their filterable properties, then retrieve time-series values for a date range. name: Stats x-whop-summary: Aggregated financial, audience, and traffic reporting. - description: > A Verification represents a legal identity for a person or business. Accounts and users complete verification when Whop needs to confirm who they are before enabling payouts or compliance-sensitive workflows. Use the Verifications API to start or resume a hosted verification session, check review status, and submit requested details or documents. If `requested_information` contains items, submit answers with [Update Verification](/api-reference/beta/verifications/update-verification). name: Verifications x-whop-summary: Legal identity required before payouts and card issuing. - description: > A Ledger Activity row is a single financial event on an account's ledger — a payment, withdrawal, refund, transfer, on-chain deposit, swap, or card transaction. Each row is derived from the underlying ledger lines and carries a typed `resource` and `source` so you can present and link the event without extra lookups. Use Ledger Activity to build a statement or transaction feed for an account or user. Reconcile against your own records with `amount` (signed, in the currency's smallest precision units) and `posted_at`, and use `available_at` to know when inflows became withdrawable. name: Ledgers x-whop-summary: The activity feed behind an account or user's balance. - description: > Payouts represent money sent from an account or user balance to an external destination, such as a bank account, wallet, or other saved payout method. Use the Payouts API to create payouts from stablecoin accounts, list payout history for accounts or users, monitor payout statuses, and show expected arrival details for funds leaving Whop. name: Payouts x-whop-summary: Send money from a balance to a bank or wallet. - description: > Cards represent Whop-issued virtual payment cards that spend from an account or user balance. Cards can be assigned to cardholders and configured with spending limits for controlled spending. Use the Cards API to issue cards, list cards for an account or user, and retrieve active card details such as the card number and CVC. name: Cards x-whop-summary: Issue cards that spend from a balance. - description: > Transfers move value between identities on Whop. They are used for account-to-account money movement, user payouts inside Whop, crypto transfers, and claim links depending on the destination type. Use the Transfers API to create a transfer, list previous transfers, and retrieve a transfer by ID when reconciling money movement between accounts or users. name: Transfers x-whop-summary: Move funds between Whop accounts and users. - description: > Deposits describe ways to add funds to an account balance, including hosted deposit pages, bank deposit instructions, and supported crypto wallet addresses. Use the Deposits API to create deposit instructions for an account. name: Deposits x-whop-summary: Add funds to a balance. - description: > Swaps convert value between supported tokens, chains, or wallet destinations for an account. A swap quote describes the expected output, fees, and approval requirements before you create the swap. Use the Swaps API to quote a conversion, create the swap, list recent swaps, and retrieve status until the transaction completes. name: Swaps x-whop-summary: Convert a balance between currencies. - description: > A Product is a digital good or service sold on Whop. Products may contain plans for pricing and/or experiences for content delivery. Use the Products API to create products, list products visible to your credentials, retrieve product details, update product metadata or merchandising fields, and delete products that should no longer be sold. name: Products x-whop-summary: The things you sell. Each owns plans and a store page. - description: > A Plan defines how customers buy a product. It controls pricing, billing cadence, availability, tax behavior, checkout fields, and purchase visibility. Use the Plans API to create plans for products, list existing plans, retrieve or update plan configuration, calculate tax for checkout, and delete plans that should no longer be offered. name: Plans x-whop-summary: 'Pricing for a product: one-time, recurring, trials, stock.' - description: > A Checkout Configuration is a reusable checkout link owned by an account. In `payment` mode it sells a specific plan; in `setup` mode it collects and saves payment details without charging. Each configuration can also override which payment methods are accepted and how 3D Secure is enforced for that checkout. Use the Checkout Configurations API to create checkout links for an existing or inline plan, list configurations for an account, retrieve the configuration behind a checkout URL, and delete links that should no longer be used. name: Checkout Configurations x-whop-summary: Turn a plan into a shareable, prefilled checkout link. - description: > The Partners API covers your Whop partner activity: the users you referred onto Whop, the businesses you referred and the earnings generated from their processing volume, and the partner leaderboard. Use it to enroll as a Whop partner, list the users you referred, list your referred businesses and review their earnings, and see the partner leaderboard. name: Partners x-whop-summary: >- The users and businesses you referred to Whop, and what you earn from them. - description: > A Bounty is a paid task posted by an account or user. The reward is held in escrow when the bounty publishes, workers submit proof of completed work, and each accepted submission is paid out until every winner slot fills. Use the Bounties API to create and publish a bounty, list an account's bounties for reporting or dashboards, list the bounties a user can work or has participated in, and retrieve a single bounty by ID. name: Bounties x-whop-summary: Paid tasks with reviewed submissions and escrowed rewards. - description: > A Bounty Submission is one worker's attempt on a bounty. It starts as an in-progress attempt, enters the review queue when proof is submitted, and ends approved (paid from the bounty's escrowed pool) or denied. Use the Bounty Submissions API to submit proof of completed work to a bounty, list the submissions you authored, and review the submissions on your bounties — across every bounty or narrowed to one. name: Bounty Submissions x-whop-summary: Work submitted to a bounty, from attempt to payout. - description: > A Person is an identity-linked profile of a visitor or customer of an account, assembled from every [event](/api-reference/beta/events/event) the person generated — pixel page views, ad clicks, leads, identifies, and payments. Each profile carries the person's known identities (names, emails, phones, user IDs), purchase history and LTV, geo/device profile, traffic sources, and the first and last marketing touches that reached them. Use the People API to list and segment the people of an account — filter by activity, purchases, traffic source, location, or marketing touch, and sort by value — or retrieve one person by person ID, user ID, email address, or phone number. name: People x-whop-summary: >- Visitors and customers of an account, with identity, purchase, and traffic profiles. - description: > An Event records conversion or engagement activity for an account, such as page views, purchases, or leads. Each event ties the action to the [person](/api-reference/beta/people/person) who took it, so activity can be attributed to the ads and links that drove it. Use the Events API to send new tracking events, list recent identity-linked events for an account, and inspect the events recorded for a person. name: Events x-whop-summary: Conversion and engagement events tracked for attribution. - description: > An Ad is the individual creative unit delivered by an [ad group](/api-reference/beta/ad-groups/ad-group). It holds the copy, creative assets, and destination URL for one ad. Use the Ads API to list ads for an account, create ads inside ad groups, retrieve or update creative details, delete ads that should stop running, and pause or resume delivery. name: Ads x-whop-summary: 'The creative: copy, assets, and destination URL.' - description: > An Ad Campaign is the top-level container for paid ads on an ad network. It sets the platform, objective, and budget strategy shared by its [ad groups](/api-reference/beta/ad-groups/ad-group) and ads. Use the Ad Campaigns API to create campaigns, list campaigns for an account, retrieve or update campaign settings, and pause or resume campaign delivery. name: Ad Campaigns x-whop-summary: Platform, objective, and budget for a set of ads. - description: > An Ad Group sits inside an [ad campaign](/api-reference/beta/ad-campaigns/ad-campaign) and controls delivery for [ads](/api-reference/beta/ads/ad). It sets the audience, placements, schedule, budget, and optimization goal for its ads. Use the Ad Groups API to create ad groups in campaigns, list or retrieve targeting and delivery settings, update budgets or targeting, delete groups that should stop running, and pause or resume delivery. It can also search the ad platform's targeting taxonomy for options to target and estimate how many people a draft targeting spec can reach. name: Ad Groups x-whop-summary: Audience, placements, and schedule within a campaign. - description: > An Audience represents a customer list uploaded to Whop for ad targeting. Audiences belong to an account and sync to supported ad platforms as custom audiences. Use the Audiences API to create audiences from CSV uploads, monitor processing status, and list or delete audiences for an account. Created audiences are usable for targeting after processing reaches `ready` or `partial`. name: Audiences x-whop-summary: Reusable targeting lists for ad groups. - description: > A Media Asset is an AI-generated image or video created from a prompt and billed from an account balance. When generation finishes, the asset includes a file that can be attached anywhere Whop accepts files. Use the Media API to start a generation job and retrieve the asset while it processes or after it is ready. name: Media x-whop-summary: >- AI-generated assets, billed from a balance, attachable wherever files are accepted. - description: > A Social Account represents an external profile connected to a Whop account or user, such as a Facebook page or Instagram account. Connecting a social account lets Whop run [ads](/api-reference/beta/ads/ad) under that profile's identity and promote its existing posts. Use the Social Accounts API to list connected accounts, create a Whop-managed Facebook page, start an OAuth connection, disconnect a social account, and list a connected profile's posts or a Facebook page's lead forms. name: Social Accounts x-whop-summary: Connected Facebook and Instagram accounts that run ads. - description: > An App is software you build on Whop. It can be a hosted web app served at `.whop.app` or an API integration installed as an experience, and it belongs to the account that owns its credentials, settings, builds, and runtime logs. Use the Apps API to manage app configuration and, for hosted apps, read server runtime logs for console output, uncaught exceptions, and failed requests. Logs are retained for 7 days and can be filtered by build, level, time window, and message text. name: Apps x-whop-summary: 'Apps you build on Whop: metadata, hosted builds, runtime logs.' - description: > An App Build is a versioned artifact uploaded for an app — a hosted web archive, or an iOS/Android bundle. Builds start as drafts, go through review, and one approved build per platform is served to users as the production build. Use the App Builds API to upload a build for an app, list an app's builds with platform and status filters, retrieve a build, and promote a draft or approved build to production. name: App Builds x-whop-summary: Versioned build artifacts deployed to an app's platforms. - description: > An API Key is a programmatic credential owned by an account or app. Each key carries its own permissions policy — explicit permission statements or an inherited system role — and can be restricted with an expiration date and an IP allowlist. Use the API Keys API to list a company or app's keys, create a key (the full secret is returned once, on creation), inspect a key's effective grants, update its name or restrictions, rotate its secret, and revoke it. These endpoints require a user session — they cannot be called with an API key. name: API Keys x-whop-summary: Programmatic credentials for an account or app. paths: /users/me: parameters: - $ref: '#/components/parameters/ApiVersionDate' get: tags: - Users summary: Retrieve Current User description: >- 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. operationId: retrieveCurrentUser parameters: - description: >- When set, returns your account-specific profile overrides for this account. in: query name: account_id required: false schema: type: string - description: >- Also compute your balance history (opt-in; runs a heavier query). Ignored for callers without balance-read scope. in: query name: include_balance_history required: false schema: type: boolean - description: >- Balance-history window start, ISO 8601 date or datetime. Defaults to 30 days ago. Only used with `include_balance_history`. in: query name: from required: false schema: type: string - description: >- Balance-history window end, ISO 8601 date or datetime. Defaults to now. Only used with `include_balance_history`. in: query name: to required: false schema: type: string - description: >- Balance-history point granularity. Defaults to `day`. Only used with `include_balance_history`. in: query name: interval required: false schema: enum: - hour - day - week - month type: string - description: >- IANA time zone the balance-history points are bucketed in. Defaults to `UTC`. Only used with `include_balance_history`. in: query name: time_zone required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' description: current user retrieved '404': $ref: '#/components/responses/NotFound' description: no authenticated user security: - bearerAuth: [] x-codeSamples: - lang: JavaScript source: |- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); const user = await client.users.me(); console.log(user.id); components: parameters: ApiVersionDate: description: Pins the request to a dated API version. in: header name: Api-Version-Date required: false schema: example: '2026-07-22' type: string schemas: User: properties: balance: description: >- 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. oneOf: - $ref: '#/components/schemas/UserBalance' - type: 'null' balance_history: description: >- 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. oneOf: - $ref: '#/components/schemas/UserBalanceHistory' - type: 'null' bio: description: The user's biography type: - string - 'null' created_at: description: When the user was created, as an ISO 8601 timestamp type: string earnings_usd: description: >- The user's gross USD income over time. Populated only on single-user self reads for callers with balance-read scope; `null` otherwise. oneOf: - $ref: '#/components/schemas/UserEarnings' - type: 'null' email: description: >- 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. type: - string - 'null' id: description: User ID, prefixed `user_`. type: string name: description: The user's display name type: - string - 'null' profile_picture: description: The user's profile picture, an object with a url type: - object - 'null' social_accounts: items: $ref: '#/components/schemas/SocialAccount' description: >- 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. type: array staff: description: >- 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. oneOf: - $ref: '#/components/schemas/UserStaffAccess' - type: 'null' username: description: The user's unique username type: string verification: description: >- 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`. type: object whop_partner_enabled_at: description: >- When the user became an enrolled Whop Partner, as an ISO 8601 timestamp. `null` if never enrolled. type: - string - 'null' required: - id - username - name - bio - created_at - profile_picture - social_accounts - email - staff - balance - earnings_usd - balance_history - verification - whop_partner_enabled_at type: object UserBalance: properties: businesses: items: $ref: '#/components/schemas/UserBalanceBusiness' description: >- Account balances for accounts the user owns, highest balance first. Excludes accounts with no balance. type: array businesses_total_usd: description: Combined USD balance across every account the user owns. type: string cash: items: $ref: '#/components/schemas/UserBalanceCash' description: Per-currency fiat cash balances. type: array cash_usd: description: Fiat cash in USD, including pending and reserve. type: string crypto: items: $ref: '#/components/schemas/UserBalanceToken' description: Per-token crypto holdings in the ledger's own wallet. type: array crypto_usd: description: Crypto holdings in USD. type: string pending_usd: description: 'Pending funds in USD: fiat pending + in-flight treasury deposits.' type: string total_usd: description: >- The user's personal balance in USD: cash (available + pending + reserve) + crypto + in-flight treasury deposits. Excludes account balances (see businesses_total_usd). type: string treasury_pending_usd: description: Balance-to-wallet USDT0 withdrawals still in flight, in USD. type: string required: - total_usd - cash_usd - crypto_usd - treasury_pending_usd - pending_usd - cash - crypto - businesses_total_usd - businesses type: object UserBalanceHistory: properties: data: items: $ref: '#/components/schemas/UserBalanceHistoryPoint' description: Cumulative balance points over the requested window, oldest first. type: array last: description: Value of the most recent point, in USD. type: number max: description: Maximum value across the window, in USD. type: number min: description: Minimum value across the window, in USD. type: number required: - data - last - min - max type: object UserEarnings: properties: first_earned_at: description: >- The first time the user earned gross income, as an ISO 8601 timestamp. type: - string - 'null' owned_accounts: $ref: '#/components/schemas/UserEarningsAmount' description: Gross income from accounts the user owns or is owner-authorized on. personal: $ref: '#/components/schemas/UserEarningsAmount' description: Gross income from the user's personal wallet. total: $ref: '#/components/schemas/UserEarningsAmount' description: >- Gross income from the user's personal wallet plus accounts they own or are owner-authorized on. required: - total - personal - owned_accounts - first_earned_at type: object SocialAccount: properties: error: description: >- 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. type: - string - 'null' external_id: description: The platform-specific ID for this social account. type: - string - 'null' id: description: Unique identifier for the social account. type: string name: description: The display name of the social account on the platform. type: - string - 'null' platform: description: The platform the social account exists on. enum: - x - instagram - youtube - tiktok - facebook - discord - telegram example: x type: string profile_picture_url: description: >- The URL where the profile picture of the social account can be accessed. type: - string - 'null' scopes: items: description: >- 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. type: string type: array url: description: >- The URL where the social account can be accessed on the platform. Null while a Whop-owned page is still being provisioned. type: - string - 'null' username: description: >- The username of the social account on the platform. Null while a Whop-owned page is still being provisioned. type: - string - 'null' verified: description: Whether the social account is verified on the platform. type: boolean required: - id - platform - username - name - url - profile_picture_url - verified - external_id - scopes - error type: object UserStaffAccess: properties: admin: description: >- Whether the user holds the admin staff role with a valid second factor. type: boolean investigation_access: description: >- Whether the user can open Whop-internal investigation tooling right now: a qualifying staff role plus their investigation toggle switched on. type: boolean manager: description: >- Whether the user holds the manager staff role with a valid second factor. type: boolean support: description: >- Whether the user holds the support staff role with a valid second factor. type: boolean required: - admin - support - manager - investigation_access type: object V1ErrorResponse: properties: error: properties: message: description: Human-readable error message. type: string type: description: Machine-readable error code. type: string required: - type - message type: object required: - error type: object UserBalanceBusiness: properties: balance_usd: description: The account's total balance in USD. type: string id: description: The account ID, which looks like biz_*************. type: string logo_url: description: The account's logo URL. type: - string - 'null' name: description: The account's display name. type: - string - 'null' required: - id - name - logo_url - balance_usd type: object UserBalanceCash: properties: balance: description: Available balance in the native currency. type: number balance_usd: description: Available balance converted to USD. type: number currency: description: Lowercase ISO currency code, such as `usd` or `eur`. type: string pending_balance_usd: description: Pending balance converted to USD. type: number reserve_balance_usd: description: Reserved balance converted to USD. type: number total_withdrawable_balance: description: Withdrawable amount in the native currency. type: number required: - currency - balance - balance_usd - pending_balance_usd - reserve_balance_usd - total_withdrawable_balance type: object UserBalanceToken: properties: balance: description: Amount held in native token units, as a decimal string. type: string icon_url: description: Token icon URL. type: - string - 'null' name: description: The token's display name. type: - string - 'null' price_usd: description: USD price per token, or `null` when unknown. type: - number - 'null' symbol: description: Token display symbol, such as `USDT`, `XAUT`, or `cbBTC`. type: string value_usd: description: Holding USD value. type: number required: - symbol - name - balance - value_usd - price_usd - icon_url type: object UserBalanceHistoryPoint: properties: t: description: Point timestamp, in Unix seconds. type: integer v: description: Cumulative wallet balance at this point, in USD. type: number required: - t - v type: object UserEarningsAmount: properties: last_24_hours: description: Gross income in USD over the last 24 hours. type: string last_30_days: description: Gross income in USD over the last 30 days. type: string last_7_days: description: Gross income in USD over the last 7 days. type: string lifetime: description: All-time gross income in USD. type: string required: - lifetime - last_30_days - last_7_days - last_24_hours type: object responses: NotFound: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Resource not found securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- 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 ***************************` scheme: bearer type: http ````