> ## 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. > ## Agent Instructions > Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages. > MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md > Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Agent mode: https://docs.whop.com/cli/agent-mode.md > Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Every agent tool: https://docs.whop.com/developer/ai/overview.md > Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Comparison: https://docs.whop.com/developer/quickstart.md > API: send `Authorization: Bearer ` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json > Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only. # Create Export > Starts an asynchronous export of a resource for an account. Returns the export in `pending`; poll `GET /exports/:id` until `download_url` is set. ## OpenAPI ````yaml /openapi/api-v1-native.json post /exports 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-11-04-1 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, suspend or delete a subaccount managed by your platform, 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 Member is one buyer's relationship with an account: one record per customer, however many memberships they hold. It tracks whether they have joined or left, their access level, and when they last opened the account's content. Use the Members API to list and search an account's members, retrieve a single member, and read a member's activity log. Member rows are created and maintained by the membership lifecycle; to grant or revoke access, work with memberships instead. name: Members x-whop-summary: One buyer's relationship with an account, across all their purchases. - 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. - description: > Search finds one account's records in one call: members, memberships, payments, affiliates, reviews, resolution center cases, promo codes and accounts. A pasted identifier finds its records exactly and they come first, ahead of ranked text matches. Use the Search API behind a search box or a command menu over an account's data: find the customer behind an email or a card, open a payment from its ID or invoice number, or jump to a member by name. To filter one resource and page through every match, use that resource's list endpoint instead. name: Search x-whop-summary: >- Find an account's members, payments and other records in one call, by ID, email, card, phone, number, link or text. - description: > An External Account represents an account on another platform linked to a Whop account or user, such as a Facebook page, Instagram account, TikTok account, or Klaviyo account. You connect it through OAuth or an API key, or Whop creates it for you. External account IDs are prefixed `sacc_`. Use the External Accounts API to list connected accounts, [connect a profile through OAuth](/api-reference/external-accounts/connect-an-external-account), [create a Whop-managed Facebook page or TikTok account, or connect a Klaviyo account with its API key](/api-reference/external-accounts/create-an-external-account), and disconnect an external account. name: External Accounts x-whop-summary: Accounts on other platforms linked to an account or user. - description: > Social Accounts is the former public name for External Accounts. Existing integrations can keep calling these deprecated endpoints while they migrate; every response points to the matching External Accounts endpoint. Use the External Accounts API for all new integrations. External account IDs keep their `sacc_` prefix, and the underlying resource is unchanged. name: Social Accounts x-whop-summary: Deprecated compatibility endpoints for external accounts. - description: > A Payment is one charge against a buyer, for one or more variants. Create an on-session payment with a `confirmation_token` for the method the buyer selected, or an off-session payment with an existing member's stored payment method. Use the Payments API to charge buyers, list and retrieve payments, and refund, void, capture, or retry them. Collection runs in the background, so the create response is not the outcome. Poll [Retrieve status](/api-reference/payments/retrieve-payment-status) for how far the payment has gone and, while it is `requires_action`, what the buyer must do next: follow a redirect, complete 3D Secure, display transfer instructions, or link a bank account. Update the payment's `return_url` to change where they land afterwards, up until they come back. name: Payments x-whop-summary: A charge against a buyer, and the step they still owe. - description: > An Invoice is a receipt with an invoice number. Create a draft from variant-backed items, set its recipient and due date, and edit it until it is sent. Its `pay_` ID is also the payment ID when collected. Draft creation does not create access or charge the buyer. The recipient's contact details live on the account's member. Financial fields and caller metadata can only be edited in draft. name: Invoices x-whop-summary: >- A payment request that keeps the same receipt from draft through collection. - description: > A Confirmation Token is a single-use, short-lived reference to a payment method and billing details collected from a buyer. Its response never returns the underlying payment credential. Whop Elements mint the token in your buyer-facing collection flow and hand you its `ctok_` ID to send to the Payments API from your server. Retrieve a token to display its payment method and billing preview or check whether it is still usable. name: Confirmation Tokens x-whop-summary: A short-lived reference to payment details collected from a buyer. - description: > A Payment Quote prices a purchase exactly as a payment for it will be charged: the same line pricing, promo code, and tax, for a buyer located by the address, country, or IP address you send. A quote is priced once, can be consumed by one payment, and expires. Use the Payment Quotes API to show a buyer the total, tax, and currency before they pay, then pass the quote's `id` as `quote_id` when you create the payment to charge exactly that quote. Quote again whenever the cart, promo code, or address changes. name: Payment Quotes x-whop-summary: 'A purchase priced before it is paid: its lines, promo code and tax.' - description: > A Setup Intent saves a buyer's payment method for later without taking money now. Create one from a confirmation token the payment elements collected in setup mode, or from a payment method already on file to re-verify it. It runs the same collection flow a payment does, so the buyer may still owe a step: 3D Secure on a card, a hosted enrollment, or linking a bank account. The create response is the setup intent as created, not its outcome. Hand its `client_secret` to the elements' `handleNextAction`, or poll [Retrieve status](/api-reference/setup-intents/retrieve-setup-status) for how far the setup has gone and what is outstanding. Once it reaches `succeeded`, `payment_method_id` names the saved method and Create Payment charges it. name: Setup Intents x-whop-summary: Saving a buyer's payment method without charging it. - description: > A Refund is one full or partial reversal of a payment, issued with [Refund Payment](/api-reference/payments/refund-payment). It records how much moved, through which provider, and whether it succeeded. Use the Refunds API to list the refunds on a payment or across an account, and to retrieve a single refund. name: Refunds x-whop-summary: Money returned to a buyer from a payment. - description: > A Resolution Center Case is opened by a buyer when something is wrong with a purchase, such as an unwanted renewal, an item that never arrived, or a charge they don't recognize. It is the step before a chargeback: the buyer and merchant work it out directly, and Whop decides the case if they can't. Use the Resolution Center Cases API from either side: as the buyer, open, reply to, appeal, or withdraw a case; as the merchant, accept it (refunding the payment), deny it, or ask the buyer for more information. name: Resolution Center Cases x-whop-summary: File or respond to a case against a payment, as the buyer or the merchant. - description: > A Dispute alert is an early warning from a card issuer that a settled payment is being questioned, ahead of any chargeback. `type` separates fraud reports (`early_fraud_warning`), pre-dispute notices (`dispute_alert`), and Visa RDR cases the network already closed by refunding (`rapid_dispute_resolution`). Use the Dispute alerts API to list alerts for an account, filter them by type or payment, and read `actionable` to see whether refunding can still avoid the chargeback. name: Dispute alerts x-whop-summary: Issuer warnings that arrive before a chargeback does. - description: > A Dispute is a chargeback a customer files against a payment through their bank, or an inquiry that may become one. It carries the disputed payment, a deadline to respond, your evidence, and the outcome once the processor rules. Use the Disputes API to list disputes, edit the evidence packet while a dispute is still contestable, and submit it for review, or accept a chargeback you don't want to contest. name: Disputes x-whop-summary: Chargebacks filed against an account, with evidence and outcomes. - description: > A Payment Rule lets an account act on its own payments before they reach the bank: block them, let them through, send them to review, or ask the buyer for 3D Secure. Each rule matches on a small set of payment attributes, and every condition must hold for it to apply. A rule's definition is fixed once created, so the payments it decided keep naming the rule that decided them. Use [Replace](/api-reference/payment-rules/replace-a-payment-rule) to change one, and [List fields](/api-reference/payment-rules/list-fields) for the attributes, operators and values a condition can use. name: Payment Rules x-whop-summary: Rules an account writes to decide its own payments. - description: > To accept payment-financing methods, an account applies through a financing application: a request to review the account for payment financing, not a loan or business capital. Create an application, save answers to its requirements, then submit it for review. You can manage applications for your own account and its direct subaccounts. name: Financing Applications x-whop-summary: An account's request to accept buy-now-pay-later payment methods. - description: > Deposits describe the ways to add funds to an account or user balance: a hosted deposit page, bank transfer instructions, and crypto wallet addresses. Use the Deposits API to get deposit instructions for an account or user, such as a crypto address to send funds to or bank details for a transfer. name: Deposits x-whop-summary: Add funds to a balance. - description: > A Transfer moves money between Whop balances: from one account or user to another, from an account's wallet to a person or address, or into a claim link anyone with the URL can redeem. Use the Transfers API to send money, find recipients you can pay, list and retrieve transfers when reconciling money movement, and preview or redeem claim links. Subscribe to `transfer.completed` and `transfer.failed` for outcomes instead of polling. Each participating account can subscribe to these events. `transfer.created` is also emitted on success, not when processing starts. A failed transfer can be retried under the same ID and later succeed; retrieve the transfer to reconcile its current status. A successful balance transfer credits the recipient's available balance unless a release date applies. Transfers funded from pending balance retain a release date and credit pending balance; applicable recipient reserves or fraud holds can keep funds unavailable. `succeeded` confirms the transfer completed, not that all funds are withdrawable. name: Transfers x-whop-summary: Move funds between Whop accounts and users. - 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 and track payouts, manage saved payout methods, 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: > A Financial Activity row is a single movement of money in or out of an account's or user's balance: a payment, payout, refund, transfer, on-chain deposit, swap, or card transaction. Each row carries a typed `resource` and `source` so you can present and link the event without extra lookups. Use the Financial Activity API to build a statement or transaction feed for an account or user, and financial reports to summarize balance activity, income, and balances over a date range, then break a report total down into what drove it. name: Ledgers x-whop-docs-title: Financial Activity x-whop-summary: The activity feed behind an account or user's balance. - description: > Cards represent 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, retrieve active card details such as the card number and CVC, and list the transactions made with them. name: Cards x-whop-summary: Issue cards that spend from a balance. - description: > A Cashback Rule pays a platform's direct subaccounts back a share of their card spend, funded by the platform. Each rule sets a rate, an eligibility window, and optional merchant filters, and can be limited to one subaccount. Use the Cashback Rules API to create, update, and list the rules your platform funds, then pay out cashback on demand from your available USD balance. name: Cashback Rules x-whop-summary: Configure platform-sponsored card cashback. - description: > A Swap converts value between supported tokens, chains, or wallet destinations, or between fiat currencies at the mid-market rate, for an account or user. A swap quote previews 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 a swap's status until it completes. name: Swaps x-whop-summary: Convert a balance between currencies. - description: > A Trade is one request on an account's or user's Whop-managed wallet. An `order` on a perpetual trades from the trading balance, bridging the USDT0 it needs from the wallet first when the balance is short; an `order` on spot swaps between USDT0 and the asset in the wallet. A `close` closes the whole position in one market; when the account is then flat, a `withdraw` trade sends the trading balance back to the wallet. A `deposit` or `withdraw` moves money between the wallet and the trading balance. Perpetuals trade on Hyperliquid. Use the Trades API to list the markets you can trade, place orders, close positions and move funds, and follow each trade until it finishes. Trades run in the background; an order that bridged money in and does not fill sends that money back to the wallet, and `funds_location` says where the money is. The trading API, including `include_trading` on accounts and users, is in beta. It can change without a new API version date. name: Trades x-whop-summary: >- Place orders, close positions, and move funds for perpetual and spot trading from a Whop-managed wallet. - 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/verifications/update-verification). name: Verifications x-whop-summary: Legal identity required before payouts and card issuing. - description: > A Product is a digital good or service sold on Whop. Products contain variants for pricing and may contain experiences for content delivery. Use the Products API to search the public marketplace, list an account's products, retrieve a product, and create, update, or delete products. name: Products x-whop-summary: The things you sell. Each owns variants and a store page. - description: > A Variant is one purchasable configuration of a product. It controls price, billing cadence, stock, SKU, attributes, tax behavior, checkout fields, and purchase visibility. Variant IDs remain prefixed `plan_`. Use the Variants API to create variants for products, list existing variants, retrieve or update variant configuration, calculate tax for checkout, and delete variants that should no longer be offered. name: Variants x-whop-summary: Purchasable configurations of a product. - description: > A Promo Code is a discount a buyer enters at checkout, either a percentage or a fixed amount off. It belongs to an account, can be limited to one product, and controls who can redeem it, how many times, until when, and for how many billing periods the discount lasts. Use the Promo Codes API to create codes for an account, list and retrieve them, deactivate a code to pause redemptions or activate it again, and archive codes you no longer offer. name: Promo Codes x-whop-summary: Discounts that creators configure for checkout. - description: > A Checkout Configuration is a reusable checkout link owned by an account. In `payment` mode it sells a specific variant; 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 variant, 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 variant into a shareable, prefilled checkout link. - description: > A Waitlist Entry is a user's signup for a variant that requires seller approval. Joining doesn't grant a membership or charge a payment method; the seller approves or denies each signup. Use the Waitlist Entries API to join a waitlist, read or cancel your own signups, and approve or deny the signups for accounts you operate. name: Waitlist Entries x-whop-summary: Join waitlists and manage customer signups awaiting approval. - description: > A Membership is a customer's purchase of a variant: the subscription or one-time grant that gives them access to a product. It tracks billing state (`active`, `trialing`, `past_due`, and so on), the current period, pending cancellations, custom metadata, and the software license key when the product includes licensing. Use the Memberships API to list an account's memberships or your own, retrieve one by ID or license key, invite a recipient to join through a free variant, and manage the lifecycle: cancel immediately or at period end, reverse a scheduled cancellation, pause and resume payment collection, extend or reactivate access, apply a promo code or affiliate, change renewal cadence, resync access, generate a transfer link, and update metadata. name: Memberships x-whop-summary: A customer's purchase of a variant, from checkout through cancellation. - description: > A Shipment attaches a carrier tracking number to a payment and follows the package from label creation to delivery, exposing the current delivery status and a customer-facing tracking URL. Use the Shipments API to list an account's shipments, retrieve one by its ID or the payment it fulfills, attach a tracking number to a payment, and update the tracking number on an existing shipment. name: Shipments x-whop-summary: Track the delivery of an order by its carrier tracking number. - description: > A Review is a customer's star rating and optional written feedback on a product, shown on the product's store page. Use the Reviews API to list a product's reviews, filtered by star rating or creation date, and retrieve a review by ID. name: Reviews x-whop-summary: Customer star ratings and written feedback on a product. - description: > A Review Report is a request from an account's admins for Whop staff to review a customer's review. Staff remove the review if it breaks the guidelines. Use the Review Reports API to list the reports filed on an account's reviews, narrowed by review, status, or creation date, and check whether a report is still pending. name: Review reports x-whop-summary: Reports an account's admins filed against customer reviews. - description: > A Product Affiliate represents a user's enrollment in a product's affiliate program. An enrollment can exist before the user makes a referral or earns a reward. Use the Product Affiliates API to list product affiliates for an account, search by affiliate name or username, and narrow the results by product, enrollment status, or signup date. name: Product Affiliates x-whop-summary: >- Users enrolled to promote a product, including affiliates with no referrals. - description: > A Domain is a hostname an account holds on Whop. Its capabilities set what Whop does with it: `registration` buys the domain through Whop, runs its DNS, and renews it every year; `verification` connects a domain registered elsewhere once you publish the DNS records it returns, and expires if ownership is not proven within 48 hours; `website` serves one of the account's apps on it. Use the Domains API to search for a domain to buy, buy or connect one, serve a website on it, and check its DNS, payment, and renewal state. Thirty days before a bought domain expires, Whop opens a renewal charge at `purchase_url` and, while `auto_renew` is on, charges the saved card. An unpaid domain stops serving when it expires but stays renewable at `purchase_url` until the registry's grace period ends, and is then removed. name: Domains x-whop-summary: Custom domains assigned to hosted apps. - description: > An App is software you build on Whop. It can be a hosted web app served at its domains, such as a `whop.site` address or a custom domain, 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, deploy an app's working copy and follow the run on the app's `deployment` field, and, for hosted apps, read server runtime logs for console output, uncaught exceptions, and failed requests. Apps are also reusable blueprints. List official blueprints with `app_type=website&verified=true&order=template_usage`, or community blueprints with `app_type=website&verified=false&recommended=true&order=template_usage`. Pass the returned App `id` as `blueprint_id` when creating an Account. 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 App Installation represents one install of your app on one account. An account installs an app once, however many experiences it adds, so an installation holds state that belongs to the account rather than to one experience, such as a sync cursor or the ID of the account it's linked to in another system. Use the App Installations API to [list the accounts your app is installed on](/api-reference/app-installations/list-app-installations), [retrieve one](/api-reference/app-installations/retrieve-app-installation), and [update](/api-reference/app-installations/update-app-installation) the `metadata` and `external_id` your app keeps on it. An account can also list the apps installed on it, and a developer every installation of their app. Only the app and its developer see `metadata` and `external_id`, and only the app can change them. name: App Installations x-whop-summary: >- Your app's installations on accounts, and the data it keeps about each one. - description: > An Experiment is a feature flag or A/B test owned by an account. Treatments take stable percentage ranges of traffic and everyone else gets control, so growing an allocation never moves an existing user to another arm. Use the Experiments API to create a draft, configure its weights, targeting, and resource bindings, then activate, pause, or end it, and to evaluate which arm a user, account, or anonymous visitor gets. Managing experiments requires `experiment:read` or `experiment:manage`; evaluation works without authentication. name: Experiments x-whop-summary: Feature flags and A/B experiments for gradual rollout. - description: > An Ad Campaign is the top-level container for paid ads. It sets the objective and budget strategy shared by its [ad groups](/api-reference/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. Ads billing combines eligible spend across the account's campaigns. A failed payment blocks delivery with `delivery_status: payment_failed` while preserving the configured active/paused `status`. Fix the account's payment method and [retry its ads payment](/api-reference/accounts/retry-failed-ads-payments) once for the account. The retry is asynchronous: acceptance does not confirm payment. Successful settlement clears the block; active campaigns can resume if otherwise eligible, while paused campaigns stay paused. See [billing and retries](/developer/ads/overview#paying-for-ads). name: Ad Campaigns x-whop-summary: Objective and budget for a set of ads. - description: > An Ad Group sits inside an [ad campaign](/api-reference/ad-campaigns/ad-campaign) and controls delivery for [ads](/api-reference/ads/ad). It sets the audience, schedule, and budget 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. name: Ad Groups x-whop-summary: Audience, schedule, and budget within a campaign. - description: > An Ad is the individual creative unit delivered by an [ad group](/api-reference/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 Audience is a reusable group of people to include or exclude when targeting ads. Build custom audiences from customer lists or Whop People data, and create lookalikes to reach people similar to an existing audience. Use the Audiences API to create audiences, add people to an uploaded customer list, rename or refilter an audience, and monitor asynchronous processing. Whop People audiences can refresh automatically or keep a snapshot. name: Audiences x-whop-summary: Reusable targeting lists for ad groups. - description: > An Ad Pixel connects a pixel you own on an ad platform to a business whose campaigns you claimed through the advertiser supplier program. Whop sends that pixel the conversions credited to your claimed campaigns for that business, using the access token you provide. Use the Ad Pixels API to add one pixel per business on each ad platform, list or retrieve your pixels, replace an access token the ad platform rejected, and remove a pixel to stop deliveries. name: Ad Pixels x-whop-summary: Your own pixels that receive conversions from campaigns you claimed. - 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 the metrics you can chart and retrieve one as a time series over a date range, or list reports and retrieve aggregates that are not bucketed over time, such as platform-wide payment trends. name: Stats x-whop-summary: Aggregated financial, audience, and traffic reporting. - description: > A Person is an identity-linked profile of a visitor or customer of an account, assembled from every [event](/api-reference/events/event) the person generated, such as pixel page views, ad clicks, leads, and payments. Use the People API to list and segment the people of an account by activity, purchases, traffic source, or marketing touch, and to 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/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. The resource also exposes an anonymized read mode — the pulse feed — a platform-wide snapshot of recent purchases that carries nothing identifying. The pulse feed is public; other Events endpoints require authentication and are scoped to an account. Events are only as good as the pixel sending them, so [Validate Pixel](/api-reference/events/validate-pixel) answers whether an account's pixel is working: it reads the events the pixel has sent, and when you pass a `url` whose page hasn't sent any lately, it fetches that page and looks for the pixel in its source. Use it before launching an ad to confirm its destination is tracked, or in a setup flow to tell a merchant whether their install is live. name: Events x-whop-summary: Conversion and engagement events tracked for attribution. - description: > An Export is a CSV of one of an account's dashboard tables, such as members, payments, or disputes. Exports are generated in the background, so a new export starts `pending` and becomes `completed` with a download link. Use the Exports API to start an export, poll it until `download_url` is set, and list an account's past exports. Each table requires its own export scope, and finished files are deleted after 30 days. name: Exports x-whop-summary: Asynchronous CSV dumps of an account's dashboard data. - description: > Economic Intelligence is Whop's recommendation engine for an account. Each recommendation is one action: a title the owner sees, a step-by-step brief Whop AI carries out, and the result it expects. Whop generates them from the account's sales, site, ads, and what its owner has said. Use the Economic Intelligence API to list an account's recommendations, request new ones for a specific goal, and follow each one from `queued` to `ready`, then to `executed` once the owner runs it or `superseded` when a newer one replaces it or you retire it. Read `economic_intelligence_offers` from account preferences and send one of its keys as `economic_intelligence_duration_key` to turn it on. name: Economic Intelligence x-whop-summary: What an account should do next to grow, generated from its own data. - description: > A Livestream represents a live video broadcast in an experience. After a recorded livestream ends, members can watch the replay, and moderators can pin the best recordings to feature them. Use the Livestreams API to [list an experience's livestreams](/api-reference/livestreams/list-livestreams), [retrieve one](/api-reference/livestreams/retrieve-livestream) with its recording, and [pin](/api-reference/livestreams/pin-livestream) or [unpin](/api-reference/livestreams/unpin-livestream) recordings. name: Livestreams x-whop-summary: Live video broadcasts in an experience, and their recordings. - description: > A Notification is a message delivered to a user, such as a new post, a payment, or a mention. Each one comes from an experience the user belongs to or a team they are on, and falls under a topic, like new sales, that users set preferences on. Use the Notifications API to list a user's feed, read and clear unread badges, send notifications from your app to an experience's users or an account's team, and list the topic catalog that notification preferences reference. name: Notifications x-whop-summary: >- The user's notification feed: unread badges, mark-read, app sends, and the topic catalog. - description: > An Email address is a mailbox on one of the account's domains, such as support@example.com. The domain needs the `email` capability in the `ready` state first. A mailbox either belongs to one team member, who alone can read it and send from it, or is shared by the account, where `email:read` and `email:send` decide who can use it. Use the Email addresses API to create, list, reassign and delete mailboxes, read the password mail apps sign in with, and download a configuration profile that adds the mailbox to Mail on Apple devices. Deleting an address keeps its mail, and creating it again in the same account brings the mailbox back. name: Email addresses x-whop-summary: Mailboxes on an account's domains, for sending and receiving email. - description: > Get started at [whop.com/network](https://whop.com/network). A Partner is a user who refers people and businesses to Whop. The partner profile includes enrollment, active direct business referral counts, and default payout terms. Retrieve your profile with `/partners/me`. Use `/partner_referral_requests` to create and manage referral links and their rewards. You can also enroll in the partner program, review referred users and businesses, track earnings, and see the partner leaderboard. name: Partners x-whop-summary: >- Your partner profile, referral links, payout rates, and referred businesses. - description: > A Partner Referral Request is a partner's referral link, or a request to be credited as the referrer of an existing business or user. An attribution request takes effect only when the recipient accepts it. Use the Partner Referral Requests API to create referral links, send attribution requests, list the links and requests you've sent or received, and accept, decline, or cancel a pending request. name: Partner Referral Requests x-whop-summary: Request business or partner attribution and manage approval. - 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 File is an uploaded document or media object, identified by a `file_` ID. Creating a file returns a presigned destination; upload the bytes there and the file becomes `ready`. Use the Files API to create a file, upload its content directly to storage (in one PUT, or in parts for large files), and retrieve it while polling for readiness. A ready file's ID can be attached wherever Whop accepts files. name: Files x-whop-summary: Upload files and attach them wherever Whop accepts documents. - 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: > 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 an account 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. - description: > A Webhook is an endpoint on your server that Whop sends signed HTTP POST requests to when events happen, such as a payment succeeding or a membership going active. A webhook is attached to an account or an app and subscribes to the events you choose. Use the Webhooks API to create and update endpoints, send a test event, inspect the delivery log, and replay deliveries your server missed. See [Webhooks & Events](/developer/guides/webhooks) for verifying signatures and handling retries. name: Webhooks x-whop-summary: Event notifications pushed to your server as things happen. - description: > A Permission is one action, such as `stats:read`, paired with whether your credential is granted it on a given resource. It answers for whatever you authenticated with, so you can decide what to show or attempt instead of discovering a `403`. Use the Permissions API to check an account, product, experience, or app, narrowing to the actions you care about. It reports only your own access — to manage who else can reach an account, use the Team Members API. name: Permissions x-whop-summary: What your credential is allowed to do on a resource. - description: > An Api Log is a record of a single request made to Whop's API using one of your account's API keys — the programmatic counterpart to the dashboard audit log, which only records actions taken by signed-in team members. Reads and failed requests are logged too. Use the Api Logs API to see what your integrations are doing on Whop: the operation, HTTP method and status, outcome, and timing of each request, newest first. name: Api Logs x-whop-summary: Requests made to Whop's API with your account's API keys. - description: > A feedback submission sends an issue, confusing behavior, documentation gap, or unanswered question to Whop. It is recorded under the authenticated user, account, or app, with an optional account for context, and reviewed by Whop. User, account, and app credentials can all submit. The response is a receipt with an `fbk_` ID: Whop does not reply to submissions, and they cannot be listed or retrieved through the API. name: Feedback x-whop-summary: Issues and unanswered questions sent to Whop for review. paths: /exports: parameters: - $ref: '#/components/parameters/ApiVersionDate' post: tags: - Exports summary: Create Export description: >- Starts an asynchronous export of a resource for an account. Returns the export in `pending`; poll `GET /exports/:id` until `download_url` is set. operationId: createExport parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/json: schema: properties: account_id: description: >- The account to export from, prefixed `biz_`. Defaults to the credential's account. example: biz_xxxxxxxxxxxxxx type: string columns: description: >- Column keys to include. Empty means all columns for the resource. items: example: member_user_name type: string type: array filters: description: >- Resource-specific filters. For native REST resources (`payouts`, `transfers`, `products`) these are the resource's own list query params; for dashboard tables they mirror the dashboard table filters.
Filters by resource (26)
ad_campaigns (5) Mirrors the filtering query params of `GET /api/v1/ad_campaigns`. - `campaign_type` `string` — Only return campaigns of this type. One of `standard`, `search`. - `created_after` `string` — Only return campaigns created after this timestamp. - `created_before` `string` — Only return campaigns created before this timestamp. - `query` `string` — Filter campaigns by a title or ID substring. - `status` `string` — Only return campaigns with this status. One of `draft`, `active`, `paused`, `payment_failed`.
ad_groups (6) Mirrors the filtering query params of `GET /api/v1/ad_groups`. - `ad_campaign_id` `string` — Filter to ad groups in this campaign. - `ad_campaign_ids` `string[]` — Filter to ad groups in these campaigns (max 100). Repeat the parameter for each id (ad_campaign_ids=a&ad_campaign_ids=b). - `created_after` `string` — Only return ad groups created after this timestamp. - `created_before` `string` — Only return ad groups created before this timestamp. - `query` `string` — Filter ad groups by a title or ID substring. - `status` `string` — Filter to ad groups with this status. One of `active`, `paused`, `rejected`, `duplicating`.
ads (8) Mirrors the filtering query params of `GET /api/v1/ads`. - `ad_campaign_id` `string` — Only return ads in this ad campaign. - `ad_campaign_ids` `string[]` — Only return ads in these ad campaigns (max 100). Repeat the parameter for each id (ad_campaign_ids=a&ad_campaign_ids=b). - `ad_group_id` `string` — Only return ads in this ad group. - `ad_group_ids` `string[]` — Only return ads in these ad groups (max 100). Repeat the parameter for each id (ad_group_ids=a&ad_group_ids=b). - `created_after` `string` — Only return ads created after this timestamp. - `created_before` `string` — Only return ads created before this timestamp. - `query` `string` — Filter ads by a title or ID substring. - `status` `string` — Only return ads with this status. One of `active`, `paused`, `in_review`, `rejected`.
apps (7) Mirrors the filtering query params of `GET /api/v1/apps`. - `app_type` `string` — Filter apps by the type of end-user they are built for. Apps of type `website` are left out unless you ask for them by name. One of `b2b_app`, `b2c_app`, `company_app`, `component`, `website`. - `product_category` `string` — Only return apps whose `product_category` is this product category, such as `pressure_washing`. An unknown product category is rejected. - `query` `string` — A search string matched against app names. - `recommended` `boolean` — Only return apps Whop recommends (or, with `false`, only those it does not), independently of verification status. - `verified` `boolean` — Only return apps whose Whop verification status matches this value. Omit this filter to include every verification status the caller can see. - `verified_apps_only` `boolean` — Legacy compatibility filter. Use `verified` for field equality. `true` returns verified apps; clients pinned before `2026-08-25-2` retain the earlier public website discovery behavior. - `view_type` `string` — Only return apps supporting this view type, such as `dashboard` or `hub`. One of `hub`, `discover`, `dash`, `dashboard`, `analytics`, `skills`, `openapi`.
audiences (3) Mirrors the filtering query params of `GET /api/v1/audiences`. - `audience_id` `string` — Audience ID, prefixed `adaud_`, used to filter the response to one audience. - `audience_type` `string` — Filter by custom or lookalike audiences. One of `custom`, `lookalike`. - `source_type` `string` — Filter by uploaded customer lists, Whop People filters, or social engagement. One of `csv_upload`, `people_filter`, `engagement`.
bounties (8) Mirrors the filtering query params of `GET /api/v1/bounties`. - `business_goal_type` `string` — Filter by the poster's declared goal. Bounties created before the goal taxonomy carry no goal and never match this filter. One of `clipping`, `post_engagement`, `owned_account_growth`, `ugc_content`, `local_activation`, `data_capture`, `other`. - `country` `string` — Only bounties workable from this country, as an ISO 3166-1 alpha-2 code. Bounties with no country targeting are workable worldwide and always match. - `created_after` `string` — Only bounties created after this ISO 8601 timestamp. - `created_before` `string` — Only bounties created before this ISO 8601 timestamp. - `experience_id` `string` — Only bounties posted to this forum experience, prefixed `exp_`. An unknown experience, or one outside the caller's scope, matches nothing. - `query` `string` — Substring match on the bounty title or ID. - `status` `string` — Filter by lifecycle state. One of `scheduled`, `open`, `closed`, `completed`, `canceled`. - `user_id` `string` — List the bounties this user participated in (`user_` tag). Must be the authenticated user.
bounty_submissions (4) Mirrors the filtering query params of `GET /api/v1/bounty_submissions`. - `bounty_id` `string` — Only submissions on this bounty (`bnty_` tag). - `created_after` `string` — Only submissions created after this ISO 8601 timestamp. - `created_before` `string` — Only submissions created before this ISO 8601 timestamp. - `status` `string` — Filter by lifecycle state. One of `in_progress`, `submitted`, `approved`, `denied`.
card_transactions (7) Mirrors the filtering query params of `GET /api/v1/card_transactions`. - `card_id` `string[]` — Return only transactions charged to these cards, each prefixed `icrd_`. - `cardholder_id` `string[]` — Return only transactions on cards assigned to these users, each prefixed `user_`. - `created_after` `string` — Return only transactions authorized at or after this ISO 8601 timestamp. - `created_before` `string` — Return only transactions authorized at or before this ISO 8601 timestamp. - `status` `string` — Return only transactions with this status. One of `pending`, `completed`, `reversed`, `declined`. - `transaction_ids` `string[]` — Return only these card transactions, each prefixed `citx_`. Repeat the parameter, or pass one comma-separated value. - `user_id` `string` — The user whose personal card transactions to list, prefixed `user_`. Provide this or `account_id`. Only that user can read them.
checkout_configurations (3) Mirrors the filtering query params of `GET /api/v1/checkout_configurations`. - `created_after` `string` — Only return checkout configurations created after this ISO 8601 timestamp. - `created_before` `string` — Only return checkout configurations created before this ISO 8601 timestamp. - `variant_id` `string` — Only return checkout configurations for this variant ID, prefixed `plan_`.
disputes (6) Mirrors the filtering query params of `GET /api/v1/disputes`. - `created_after` `string` — Only disputes opened after this ISO 8601 timestamp. - `created_before` `string` — Only disputes opened before this ISO 8601 timestamp. - `currency` `string` — Only disputes in this three-letter ISO currency. - `include_subaccounts` `boolean` — Also cover the account's subaccounts. Requires `account_id`, and is a 400 without it. Without `query`, covers the disputes of the account and every subaccount, in any order. The listing is cut off after 10 seconds; add a `query` to narrow it. With `query`, matches on dispute, payment, user or membership ID, buyer email, or a card's first 6 or 8 digits and last 4 separated by a space or dash (`424242 4242`); free-text queries such as a name search only the named account. Subaccounts' disputes are returned only for subaccounts you can read disputes on. - `query` `string` — Search disputes by dispute ID, payment ID, user ID, membership ID, user email, name, or username. Email filtering requires the member:email:read permission. - `status` `string[]` — Only disputes in these statuses. Repeat the parameter to pass several — one paginated list covers all of them. Inquiries match only the `warning_` statuses. A `needs_response` dispute whose evidence deadline has passed reports and filters as `under_review` instead.
events (14) Mirrors the filtering query params of `GET /api/v1/events`. - `attribution_model` `string` — Attribution model for the source filter (defaults to last_touch). One of `last_touch`, `first_touch`. - `browser` `string` — Browser families to filter by, comma-separated (e.g. Chrome, Mobile Safari). - `city` `string` — Cities to filter by, comma-separated. - `country` `string` — Country codes to filter by, comma-separated. - `device` `string` — Device families to filter by, comma-separated (e.g. iPhone, Mac). - `event` `string` — Full event names to filter by, comma-separated (payment.completed, pixel.lead, pixel.page, pixel.custom:) — the same vocabulary the events / people metrics use. - `from` `string` — Start of the time range as an ISO 8601 timestamp. Required when identifier is omitted. - `hostname` `string` — Page hostnames to filter by, comma-separated. - `identifier` `string` — Any hard identifier of the person: a person ID (prsn_*), user ID, email, phone number, or a tracking cookie value (wuid, anonymous ID, fbp/fbc/ttp/ga). Omit to list recent events for the account. - `os` `string` — Operating system families to filter by, comma-separated (e.g. iOS, Windows). - `page` `string` — Page paths to filter by, comma-separated. - `source` `string` — Canonical source path, exact or with a trailing :* prefix (whop::*, ext:meta:*, referrer:, direct, unknown). Selects conversions credited to this source. - `to` `string` — End of the time range as an ISO 8601 timestamp. Required when identifier is omitted; otherwise defaults to now. - `utm_source` `string` — utm_source values to filter by, comma-separated.
external_accounts (5) Mirrors the filtering query params of `GET /api/v1/external_accounts`. - `platform` `string` — Only return external accounts for the platform that is specified. An `aimerce` account is returned only with this filter, which requires the `company:manage_checkout` scope instead of `social_account:read`. One of `x`, `instagram`, `youtube`, `tiktok`, `facebook`, `discord`, `telegram`, `linkedin`, `snapchat`, `klaviyo`, `quickbooks`, `aimerce`. - `scopes` `string[]` — Only return external accounts that have these scopes. - `trust_level` `string` — Only return external accounts linked with this trust level, such as `oauth` for accounts connected through OAuth. One of `oauth`, `api_key`, `verified`, `authorized`, `claimed`, `scraped`. - `user_id` `string` — The User that the external accounts are connected to. Provide either this or account_id. - `verified` `boolean` — Only return external accounts that are verified on the platform.
financial-activity (15) Mirrors the filtering query params of `GET /api/v1/financial_activity`. - `activity_id` `string` — Optional ledger activity ID (for example `line_3`). Returns at most that one activity. - `available_after` `string` — Only include balance credits and debits available on or after this `YYYY-MM-DD` date (UTC), distinct from posted_at. Requires currency. - `available_before` `string` — Only include balance credits and debits available on or before this `YYYY-MM-DD` date (UTC). Set equal to available_after for a single day. Requires currency. - `balance_type` `string` — Which balance the activity changes. `total` includes available, pending, and reserved funds. `available` includes only movements into or out of available funds, including reservations, releases, and fees. Movements within the selected balance are omitted. Omit to preserve the existing activity feed. Requires account_id or user_id; cannot be combined with available_after or available_before. One of `total`, `available`. - `currency` `string` — Optional currency code filter, for example `usd`. - `exclude_internal_movements` `boolean` — Whether to exclude balance reservations and balanced movements between the account's own balances. - `include_owned_accounts` `boolean` — When true, aggregates the authenticated user's personal ledger with the businesses they own (owner role with balance read) into one feed. Requires user_id to be the authenticated user; cannot be combined with account_id or the settlement-date filters. Each returned row includes the owning `account`. - `include_resource` `boolean` — Whether to include the `resource` field in the response or not. Consider passing `false` if you need a fast response without as many rich details. - `line_types` `string[]` — Optional ledger line categories to include. Some categories (for example `onchain_deposit`, which covers inbound crypto deposits such as MoonPay onramps) are only returned when explicitly requested here. - `payment_id` `string` — Filter activity by payment ID (pay_), including related refunds, disputes, and fees. Combines with resource_id and other filters within the selected accounts. Unknown payments return an empty list. - `posted_after` `string` — Only include rows posted after this ISO 8601 timestamp. - `posted_before` `string` — Only include rows posted before this ISO 8601 timestamp. - `resource_id` `string` — Optional prefixed resource ID. Returns activity associated with that resource. - `user_id` `string` — The owning user ID (a user_ identifier). Provide this or account_id. - `withdrawal_id` `string` — Withdrawal ID (wdrl_). With balance_type=available, selects the same period as its statement, after the previous withdrawal and through this withdrawal, excluding this withdrawal and its fee. Requires a single account. Overrides currency and posted-date filters.
invoices (6) Mirrors the filtering query params of `GET /api/v1/invoices`. - `created_after` `string` - `created_before` `string` - `member_id` `string` - `overdue` `boolean` - `product_id` `string` - `status` `string` — One of `draft`, `open`, `authorized`, `paid`, `pending`, `uncollectible`, `unresolved`, `void`.
members (11) Mirrors the filtering query params of `GET /api/v1/members`. - `access_level` `string` — Filter by what the member can reach on the account. One of `no_access`, `admin`, `customer`. - `created_after` `string` — Only members who joined after this ISO 8601 timestamp. - `created_before` `string` — Only members who joined before this ISO 8601 timestamp. - `membership_status` `string` — `active` returns members holding at least one membership that currently grants access; `inactive` returns members holding at least one membership that does not. Combined with `product_ids`, `variant_ids`, or `promo_code_ids`, one membership must match all of them. One of `active`, `inactive`. - `most_recent_actions` `string[]` — Only return members whose `most_recent_action` is one of these values. - `product_ids` `string[]` — Only return members holding a membership to one of these products, prefixed `prod_`. Unknown IDs match nothing. - `promo_code_ids` `string[]` — Only return members holding a membership bought with one of these promo codes, prefixed `promo_`. Unknown IDs match nothing. - `query` `string` — Search members by name or username. An exact email address also matches when the credential holds the member:email:read scope. - `status` `string` — Filter by whether the member is still part of the account. One of `joined`, `left`. - `user_ids` `string[]` — Only return members whose users match these `user_` identifiers. - `variant_ids` `string[]` — Only return members holding a membership on one of these variants, prefixed `plan_`. Unknown IDs match nothing.
memberships (12) Mirrors the filtering query params of `GET /api/v1/memberships`. - `created_after` `string` — Only memberships created after this ISO 8601 timestamp. - `created_before` `string` — Only memberships created before this ISO 8601 timestamp. - `external_account` `string` — Narrow to memberships linked to one Discord or Telegram account, given as the platform's user ID prefixed with `discord_` or `telegram_`. Discord matches include memberships imported with that Discord ID. Any other format is a 400. - `member_id` `string` — Narrow to one member's memberships (`mber_` tag), including memberships bought by another business. A member outside the caller's visible set returns an empty list. - `product_id` `string` — Filter to memberships of this product (`prod_` tag). - `product_ids` `string[]` — Filter to memberships of any of these products, each prefixed `prod_`. Repeat the parameter to pass several. - `promo_code_ids` `string[]` — Filter to memberships discounted by any of these promo codes, each prefixed `promo_`. Repeat the parameter to pass several. - `status` `string` — Filter by billing state. `trialing`, `active`, `past_due`, `completed`, `canceled`, and `expired` match the membership's `status`; `active`, `trialing`, and `past_due` exclude memberships set to cancel at period end. The other values are derived buckets that never appear as a `status`: `canceling` matches memberships set to cancel at period end; `paused` matches memberships with payment collection paused; `expiring` matches one-time purchases that have not yet expired; `one_time` matches one-time purchases that never expire; `unclaimed` matches memberships with no buyer user, including memberships bought by another business; `banned` matches memberships whose buyer is banned from the account. One of `active`, `trialing`, `past_due`, `completed`, `canceled`, `expired`, `canceling`, `paused`, `expiring`, `one_time`, `unclaimed`, `banned`. - `statuses` `string[]` — Filter to memberships matching any of these billing states, with the same meanings as `status`. Repeat the parameter to pass several. Combined with `status` when both are sent. - `user_id` `string` — Narrow to one user's memberships (`user_` tag, or `me` for the caller). A user outside the caller's visible set returns an empty list. - `variant_id` `string` — Filter to memberships of this variant (`plan_` tag). - `variant_ids` `string[]` — Filter to memberships of any of these variants, each prefixed `plan_`. Repeat the parameter to pass several.
payouts (7) Mirrors the filtering query params of `GET /api/v1/payouts`. - `created_after` `string` — Only payouts created at or after this ISO 8601 time (inclusive). - `created_before` `string` — Only payouts created before this ISO 8601 time (exclusive). - `currency` `string` — Optional currency code filter, for example `usd`. - `payout_method_id` `string` — Filter to payouts sent to one saved payout method (a pytk_ identifier). An unknown id matches nothing. - `source` `string` — Filter by how the payout was created. Payouts created before source tracking or through internal tooling carry no source and never match. One of `api`, `dashboard`, `automatic`. - `status` `string` — Filter to payouts whose `status` reads this word, matching exactly what this version displays — `reversed` finds settled payouts the bank later returned. Requires Api-Version-Date 2026-08-21 or later. One of `requested`, `in_review`, `processing`, `completed`, `reversed`, `canceled`, `failed`, `denied`. - `user_id` `string` — The owning user ID (a user_ identifier). Provide this or account_id.
people (39) Mirrors the filtering query params of `GET /api/v1/people`. - `aov_gt` `number` — Select people whose lifetime aov is greater than this value. LTV and AOV are in USD. - `aov_gte` `number` — Select people whose lifetime aov is at least this value. LTV and AOV are in USD. - `aov_lt` `number` — Select people whose lifetime aov is less than this value. LTV and AOV are in USD. - `aov_lte` `number` — Select people whose lifetime aov is at most this value. LTV and AOV are in USD. - `attribution_model` `string` — Attribution model the source filter matches against (defaults to last_touch). One of `last_touch`, `first_touch`. - `audience_id` `string` — Only include people in this audience. An audience that keeps itself up to date resolves to the People filters that define it, so this always reflects who matches now; uploaded lists and point-in-time snapshots match their recorded members. - `contactable` `boolean` — true for people who have an email address or phone number — the ones an ad platform can match. - `country` `string` — Only include people with activity from this ISO 3166-1 alpha-2 country code. - `custom_event` `string` — Only include people who fired this custom pixel event. - `email` `string` — Only include the person linked to this email address. - `event_count_gt` `number` — Select people whose lifetime event_count is greater than this value. LTV and AOV are in USD. - `event_count_gte` `number` — Select people whose lifetime event_count is at least this value. LTV and AOV are in USD. - `event_count_lt` `number` — Select people whose lifetime event_count is less than this value. LTV and AOV are in USD. - `event_count_lte` `number` — Select people whose lifetime event_count is at most this value. LTV and AOV are in USD. - `event_from` `string` — The inclusive start of the matching activity window. - `event_name` `string[]` — Only include people who fired any of these events, e.g. payment.completed or page.checkout.view. - `event_to` `string` — The inclusive end of the matching activity window, for both stats drilldowns and saved audiences. - `event_within_days` `integer` — Match activity within a rolling number of days. Cannot be combined with event_from/event_to. - `first_seen_after` `string` — Only include people first seen at or after this ISO 8601 timestamp. - `first_seen_before` `string` — Only include people first seen before this ISO 8601 timestamp. - `first_seen_within_days` `integer` — Only include people first seen within this many days, as a rolling window. - `from` `string` — Inclusive activity-window start. Alias for event_from. - `has_purchased` `boolean` — true for customers only, false for people who have never purchased. - `last_seen_after` `string` — Only include people last seen at or after this ISO 8601 timestamp. - `last_seen_before` `string` — Only include people last seen before this ISO 8601 timestamp. - `last_seen_within_days` `integer` — Only include people last seen within this many days, as a rolling window. - `ltv_gt` `number` — Select people whose lifetime ltv is greater than this value. LTV and AOV are in USD. - `ltv_gte` `number` — Select people whose lifetime ltv is at least this value. LTV and AOV are in USD. - `ltv_lt` `number` — Select people whose lifetime ltv is less than this value. LTV and AOV are in USD. - `ltv_lte` `number` — Select people whose lifetime ltv is at most this value. LTV and AOV are in USD. - `phone` `string` — Only include the person linked to this phone number. - `purchase_count_gt` `number` — Select people whose lifetime purchase_count is greater than this value. LTV and AOV are in USD. - `purchase_count_gte` `number` — Select people whose lifetime purchase_count is at least this value. LTV and AOV are in USD. - `purchase_count_lt` `number` — Select people whose lifetime purchase_count is less than this value. LTV and AOV are in USD. - `purchase_count_lte` `number` — Select people whose lifetime purchase_count is at most this value. LTV and AOV are in USD. - `query` `string` — Search people by name, email, phone, or whop user ID (case-insensitive substring match). - `source` `string[]` — Only include people acquired from any of these sources — canonical paths (whop:::, ext::..., referrer:, direct, other), exact or with a trailing :* prefix. The same vocabulary the events / people metrics use. - `to` `string` — Inclusive activity-window end. Alias for event_to. - `user_id` `string` — Only include the person linked to this whop user ID.
products (10) Mirrors the filtering query params of `GET /api/v1/products`. - `access_pass_types` `string[]` — Filter to only products matching these types. - `billing_types` `string[]` — Filter to products with a buyable variant of these billing models, such as `one_time` or `renewal`. On an account list, needs the `access_pass:basic:read` permission. - `created_after` `string` — Only return products created after this ISO 8601 timestamp. - `created_before` `string` — Only return products created before this ISO 8601 timestamp. - `labels` `string[]` — Filter to only products carrying all of these labels. Labels are matched lowercased. - `marketplace_category_route` `string` — Only return marketplace products assigned to this category route, such as `trading`. - `price_maximum` `number` — Only return products whose advertised buyable variant has a displayed price of at most this amount. Recurring variants use renewal price. On an account list, needs the `access_pass:basic:read` permission. - `price_minimum` `number` — Only return products whose advertised buyable variant has a displayed price of at least this amount. Recurring variants use renewal price. On an account list, needs the `access_pass:basic:read` permission. - `query` `string` — Filters products by text. The public marketplace list searches product title, account name, headline and description, ranking products that match every word first and the closest partial matches after them; an account's own list is a plain substring match over title, headline and description. Omit to browse by recency. - `visibilities` `string[]` — Filter to only products matching these visibility states. Ignored on the public marketplace list, which only returns visible products. Without the `access_pass:basic:read` permission on the account, only `visible` matches anything.
promo_codes (5) Mirrors the filtering query params of `GET /api/v1/promo_codes`. - `created_after` `string` — Only promo codes created after this ISO 8601 timestamp. - `created_before` `string` — Only promo codes created before this ISO 8601 timestamp. - `product_ids` `string[]` — Only promo codes scoped to these product IDs. - `status` `string` — Promo-code status. `expired` groups inactive and archived codes. One of `active`, `inactive`, `archived`, `expired`. - `variant_ids` `string[]` — Only promo codes scoped to these variant IDs.
resolution_center_cases (6) Mirrors the filtering query params of `GET /api/v1/resolution_center_cases`. - `created_after` `string` — Only cases created after this ISO 8601 timestamp. - `created_before` `string` — Only cases created before this ISO 8601 timestamp. - `outcome` `string[]` — Only closed cases that ended these ways. Repeat the parameter to pass several. - `reason` `string[]` — Only cases opened for these reasons. Repeat the parameter to pass several. - `status` `string[]` — Only cases in these statuses. Repeat the parameter to pass several — one paginated list covers all of them. - `user_id` `string` — Only cases opened by this customer — a `user_` tag, or `me` for the calling user. It narrows what you can already read, so `me` lists the cases you opened without the ones on accounts you are a team member of.
shipments (4) Mirrors the filtering query params of `GET /api/v1/shipments`. - `created_after` `string` — Return shipments created after this ISO 8601 timestamp. - `created_before` `string` — Return shipments created before this ISO 8601 timestamp. - `payment_id` `string[]` — Only shipments fulfilling these payments, each prefixed `pay_`. Repeat the parameter to pass several, up to 100 per request — one paginated list covers all of them. - `status` `string` — Filter to shipments with this delivery status. One of `unknown`, `pre_transit`, `in_transit`, `out_for_delivery`, `delivered`, `available_for_pickup`, `return_to_sender`, `failure`, `cancelled`, `error`.
social_accounts (5) Mirrors the filtering query params of `GET /api/v1/social_accounts`. - `platform` `string` — Only return external accounts for the platform that is specified. An `aimerce` account is returned only with this filter, which requires the `company:manage_checkout` scope instead of `social_account:read`. One of `x`, `instagram`, `youtube`, `tiktok`, `facebook`, `discord`, `telegram`, `linkedin`, `snapchat`, `klaviyo`, `quickbooks`, `aimerce`. - `scopes` `string[]` — Only return external accounts that have these scopes. - `trust_level` `string` — Only return external accounts linked with this trust level, such as `oauth` for accounts connected through OAuth. One of `oauth`, `api_key`, `verified`, `authorized`, `claimed`, `scraped`. - `user_id` `string` — The User that the external accounts are connected to. Provide either this or account_id. - `verified` `boolean` — Only return external accounts that are verified on the platform.
team_members (11) Mirrors the filtering query params of `GET /api/v1/team_members`. - `created_after` `string` — Only return members added after this ISO 8601 timestamp. - `created_before` `string` — Only return members added before this ISO 8601 timestamp. - `direct_reports_max` `integer` — Only return members with at most this many direct reports; `0` returns the people who manage no one. Pending invites are excluded, and the list pages in `created_at` order without moving Partner-role members last. - `direct_reports_min` `integer` — Only return members with at least this many direct reports. Pending invites are excluded, and the list pages in `created_at` order without moving Partner-role members last. - `has_referred_businesses` `boolean` — When true, only members who referred at least one business for their account, the reps the `partner_reps` stats metric counts; when false, only members who referred none. Pending invites are excluded, and the list pages in `created_at` order without moving Partner-role members last. - `query` `string` — Only return members whose name or username contains this text, and invites whose email contains it. - `reports_to_id` `string` — Only return the direct reports of this team member, whose ID may start with `ausr_` or `mber_`. Pass the account ID, prefixed `biz_`, for the members who report to the business directly. Pending invites are excluded, and the list pages in `created_at` order without moving Partner-role members last. - `role` `string` — Only return members with this role. `custom` matches members on a dashboard-managed custom role. One of `owner`, `admin`, `partner`, `sales_manager`, `moderator`, `advertiser`, `app_manager`, `support`, `manager`, `workforce`, `custom`. - `status` `string` — Only return members with this status: `joined` (accepted members) or `pending` (pending invites). Both are returned by default. One of `joined`, `pending`. - `team_lead_id` `string` — Only return this user, prefixed `user_`, and everyone under them in today's org chart: the same team the stats API's `team_lead_id` reads. With `account_id=global`, their line in every partner account where they hold a role. Pending invites are excluded, and the list pages in `created_at` order without moving Partner-role members last. - `user_id` `string` — Only return the membership for this user ID, prefixed `user_`.
transfers (4) Mirrors the filtering query params of `GET /api/v1/transfers`. - `created_after` `string` — Only transfers created strictly after this ISO 8601 timestamp. - `created_before` `string` — Only transfers created strictly before this ISO 8601 timestamp. - `destination_id` `string` — Filter to transfers received by this account. - `origin_id` `string` — Filter to transfers sent from this account.
webhooks (3) Mirrors the filtering query params of `GET /api/v1/webhooks`. - `app_id` `string` — Only return webhooks attached to this app. Omit to list the account's own webhooks. - `has_failures` `boolean` — Only return webhooks whose endpoint is currently failing — every delivery since the current failure streak began has been rejected. Clears as soon as a delivery succeeds. - `include_app_webhooks` `boolean` — Also return webhooks attached to the account's apps, not just the account's own. Cannot be combined with `app_id`.
example: include_resource: false posted_after: '2026-01-01T12:00:00.000Z' posted_before: '2026-01-01T12:00:00.000Z' type: object resource: description: >- The resource to export, e.g. `payouts`, `receipts`, or `members`. enum: - ad_campaigns - ad_groups - ads - apps - audiences - bounties - bounty_submissions - card_transactions - checkout_configurations - disputes - events - external_accounts - financial-activity - payout_methods - payouts - people - plans - products - receipt_invoices - resolution_center_cases - shipments - social_accounts - team_members - transfers - webhooks - members - receipts - unclaimed_memberships - memberships - tracking_links - promo_codes - resolutions - entries - leads - invoices - cancelation_reasons - child_companies example: financial-activity type: string timezone: description: >- IANA timezone for date columns, e.g. `America/New_York`. Defaults to `UTC`. example: America/Chicago type: string required: - resource type: object required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Export' description: export created '400': $ref: '#/components/responses/InvalidParameters' description: resource is not creatable over REST '401': $ref: '#/components/responses/Unauthorized' description: unauthenticated '403': $ref: '#/components/responses/Forbidden' description: not authorized for the scope '409': $ref: '#/components/responses/Conflict' security: - bearerAuth: - access_pass:basic:read - bearerAuth: - ad_campaign:basic:read - bearerAuth: - audience:basic:read - bearerAuth: - bounty:basic:read - bearerAuth: - checkout_configuration:basic:read - bearerAuth: - child_company:basic:export - bearerAuth: - company:authorized_user:read - bearerAuth: - company:balance:read - company:balance:export - member:email:read - bearerAuth: - company:balance:read - company:balance:export - member:email:read - payout:account:read - bearerAuth: - company:basic:read - member:basic:read - member:journey:read - bearerAuth: - developer:basic:read - bearerAuth: - developer:manage_webhook - bearerAuth: - invoice:basic:export - bearerAuth: - lead:basic:export - bearerAuth: - member:basic:export - bearerAuth: - payment:basic:export - bearerAuth: - payment:basic:read - payment:basic:export - bearerAuth: - payment:dispute:read - bearerAuth: - payment:resolution_center_case:export - bearerAuth: - payment:resolution_center_case:read - bearerAuth: - payout:account:read - bearerAuth: - payout:destination:read - bearerAuth: - payout:transfer:read - bearerAuth: - payout:withdrawal:read - bearerAuth: - plan:basic:read - bearerAuth: - plan:waitlist:export - bearerAuth: - promo_code:basic:export - bearerAuth: - shipment:basic:read - bearerAuth: - social_account:read - bearerAuth: - tracking_link:basic:export x-codeSamples: - lang: TypeScript source: > import { WhopClient } from "@whop/sdk"; const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" }); await client.exports.create({ resource: "ad_campaigns" }); components: parameters: ApiVersionDate: description: Pins the request to a dated API version. in: header name: Api-Version-Date required: false schema: example: 2026-11-04-1 type: string IdempotencyKey: description: >- A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). in: header name: Idempotency-Key required: false schema: example: d9105228-4a08-46b1-8b91-42fed586d383 maxLength: 255 type: string schemas: Export: properties: created_at: description: When the export was requested, as an ISO 8601 timestamp. example: '2026-01-01T12:00:00.000Z' type: string download_url: description: >- A short-lived link to download the finished file. `null` until `status` is `completed`, and again once the export has expired. example: >- https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx type: - string - 'null' expires_at: description: >- When the file is deleted and the export moves to `expired`, as an ISO 8601 timestamp. Exports are retained for 30 days. example: '2026-01-01T12:00:00.000Z' type: string id: description: Export ID, prefixed `exprt_`. example: exprt_xxxxxxxxxxxxxx type: string progress_percent: description: Estimated completion percentage from 0 to 100. example: 0 type: - integer - 'null' resource: description: >- The resource that was exported, e.g. `receipts`, `members`, or `payouts`. enum: - ad_campaigns - ad_groups - ads - apps - audiences - bounties - bounty_submissions - card_transactions - checkout_configurations - disputes - events - external_accounts - financial-activity - payout_methods - payouts - people - plans - products - receipt_invoices - resolution_center_cases - shipments - social_accounts - team_members - transfers - webhooks - members - receipts - unclaimed_memberships - memberships - tracking_links - promo_codes - resolutions - entries - leads - invoices - cancelation_reasons - child_companies - ledger_lines - withdrawal_lines example: members type: string status: description: >- `pending` or `processing` while the file is generated, `completed` when the download is ready, `failed` if it errored, `expired` once the file has been deleted. enum: - pending - processing - completed - failed - expired example: completed type: string updated_at: description: When the export last changed, as an ISO 8601 timestamp. example: '2026-01-01T12:00:00.000Z' type: string required: - id - resource - status - progress_percent - download_url - expires_at - created_at - updated_at type: object V1ErrorResponse: properties: error: properties: code: description: >- Machine-readable reason for this specific refusal, such as `bank_warning_not_acknowledged`. Only present when the error carries one. type: string message: description: Human-readable error message. example: account_id is required type: string type: description: Machine-readable error code. example: bad_request type: string required: - type - message type: object required: - error type: object responses: InvalidParameters: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Invalid Parameters Unauthorized: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Unauthorized Forbidden: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Forbidden Conflict: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Conflict securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with `Bearer`, for example `Bearer ***************************`. See [Auth & API keys](/developer/guides/auth-scoping) for how to get each one. scheme: bearer type: http ```` ## Related topics - [Export](https://docs.whop.com/api-reference/exports/export.md) - [Create](https://docs.whop.com/api-reference/audiences/create-audience.md) - [Create webhook](https://docs.whop.com/api-reference/legacy/webhooks/create-webhook.md)