> ## 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. # Create Export > Starts an asynchronous CSV 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-08-21' 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. - description: > A Member is one buyer's relationship with an account — one record per customer regardless of how many memberships they hold. It carries relationship-level state: whether they have joined or left, their access level (`customer`, `admin`, or `no_access`), when they joined, and when they last opened the account's content. Use the Members API to list an account's members with filtering by access level, status, join date, and name or username search, and to retrieve a single member. 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. - 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: > An Export is an asynchronous CSV of one resource for one account — members, payments, disputes, ads, and the other tables the Whop dashboard can export. Generating a full table takes longer than a request, so an export is created in `pending`, moves through `processing`, and lands on `completed` with a download link. Each resource requires that resource's own export scope. Use the Exports API to start an export, poll it until `download_url` is set, and list the exports already requested for an account. Finished CSVs are retained for 30 days, after which the file is deleted and the export moves to `expired`. name: Exports x-whop-summary: Asynchronous CSV dumps of an account's dashboard data. - description: > A Notification is a message delivered to a user — a new post, a payment, a mention. Every notification comes from an experience the user belongs to or a team they are on, and users control what they receive with notification preferences. Every notification belongs to a topic: the category it falls under, such as new sales or account activity. Topics carry a default, so a user only needs a preference row where they diverge from it. `GET /notifications/topics` lists the platform's visible topics, and a topic's `id` is what the notification preference endpoints take as `topic_id` — the catalog is the only place those ids come from, so read it rather than hardcoding. Each topic also carries an `identifier` such as `new-follower`, which is stable across environments and is the value to match on in code. Use the Notifications API to list the authenticated user's feed, read per-experience unread badges, mark an experience (or everything) as read, send notifications from your app to an experience's users or an account's team, and list the topic catalog. name: Notifications x-whop-summary: >- The user's notification feed: unread badges, mark-read, app sends, and the topic catalog. - description: > A Payment is one charge against a buyer. Create it with a payment method already on file, or with a `confirmation_token` describing a method the buyer has just supplied. Collection runs in the background, so the create response is not the outcome. Poll [Retrieve status](/api-reference/beta/payments/retrieve-status) for how far the payment has got 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. Use the return_url operation 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: > A Setup Intent saves a buyer's payment method for later without taking money now. 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. Poll [Retrieve status](/api-reference/beta/setup-intents/retrieve-status) for how far the setup has got and what is outstanding. Once it reaches `succeeded` the method is on file and can be charged. name: Setup Intents x-whop-summary: Saving a buyer's payment method without charging it. - 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 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: > 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: > 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. name: Disputes x-whop-summary: Chargebacks filed against an account, with evidence and outcomes. - 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: > 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 Resolution Center Case is opened by a buyer when something is wrong with a purchase — an unwanted renewal, an item that never arrived, or a charge they don't recognize. It is the step before a chargeback: the two sides work it out directly, and Whop decides the case if they can't. Each case carries a reason, a status naming which side it is waiting on, a timeline of events, and the actions available to whoever is reading it. Use the Resolution Center Cases API from either side: as the buyer, open a case, reply, appeal a decision, or withdraw it; as the merchant, accept it (refunding the payment), deny it, or ask the buyer for more information. Both sides read the same case, page its timeline, and summarize the cases they can see. name: Resolution Center Cases x-whop-summary: File or respond to a case against a payment, as the buyer or the merchant. - 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.' - name: Promo Codes x-whop-summary: Discounts that creators configure for checkout. - description: > A Membership is a customer's purchase of a plan: 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 the caller's own, retrieve one by ID or license key, invite a recipient to join through a free plan, and manage the lifecycle: cancel immediately or at period end, reverse a scheduled period-end cancellation, pause and resume payment collection, extend with free days, generate a transfer link, and update metadata. name: Memberships x-whop-summary: A customer's purchase of a plan, from checkout through cancellation. - 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: > A Payment Method Domain registers a hostname with a wallet provider so its payment methods can appear at a checkout served from that domain. The domain proves ownership by hosting the provider's association file — for Apple Pay, at `/.well-known/apple-developer-merchantid-domain-association` — and `status` reports whether verification has completed. Use the Payment Method Domains API to register domains for your account or its connected accounts, retry verification once the association file is hosted, and remove domains that should no longer serve wallet payments. A domain a platform shares with its connected accounts at checkout is listed on the platform's account, not on each connected account. name: Payment Method Domains x-whop-summary: >- Domains verified to show wallet payment methods like Apple Pay at checkout. - 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: > 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. 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/beta/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: > A Recommended Action Chain is a short, ordered sequence of dashboard actions — create a product, price it, publish it — suggested for an account based on what it already has. Seeded chains come from hand-written presets; generated chains, produced per account, share the same shape. Use the Recommended Actions API to list the chains recommended for an account and to record that a chain was run. Running a chain executes nothing server-side — the client follows each step's CTA itself; the run endpoint records the `recommended_action_chain.executed` analytics event. name: Recommended Actions x-whop-summary: Suggested next-step action chains for an account. - 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, 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. 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 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 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. paths: /exports: parameters: - $ref: '#/components/parameters/ApiVersionDate' post: tags: - Exports summary: Create Export description: >- Starts an asynchronous CSV 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`, `memberships`) these are the resource's own list query params; for dashboard tables they mirror the dashboard table filters.
Filters by resource (25)
ad_campaigns (4) Mirrors the filtering query params of `GET /api/v1/ad_campaigns`. - `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 (4) 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`. - `query` `string` — A search string matched against app names. - `verified_apps_only` `boolean` — Whether to only return apps verified by Whop. Verified website templates — websites with a published web build — are included, even though websites are otherwise left out of app lists. - `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 audience type: `custom` (uploaded lists) or `lookalike`. One of `custom`, `lookalike`. - `source_type` `string` — Filter by member source: `csv_upload` (uploaded lists) or `people_filter` (automatic audiences built from saved People filters). One of `csv_upload`, `people_filter`.
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 (6) 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.
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. - `plan_id` `string` — Only return checkout configurations for this plan ID, prefixed `plan_`.
disputes (4) 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. - `status` `string[]` — Only disputes in these statuses. Repeat the parameter to pass several — one paginated list covers all of them. Covers both chargebacks and inquiries at each stage. 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). Restricts the list to conversion targets attributed to that source — the debuggability twin of a metric cell's source parameter. - `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.
financial-activity (9) Mirrors the filtering query params of `GET /api/v1/financial-activity`. - `available_after` `string` — Only include rows whose funds became withdrawable on or after this `YYYY-MM-DD` settlement date (UTC), distinct from posted_at. Requires currency. - `available_before` `string` — Only include rows whose funds became withdrawable on or before this `YYYY-MM-DD` settlement date (UTC). Set equal to available_after for a single day. Requires currency. - `currency` `string` — Optional currency code filter, for example `usd`. - `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. - `posted_after` `string` — Only include rows posted after this ISO 8601 timestamp. - `posted_before` `string` — Only include rows posted before this ISO 8601 timestamp. - `user_id` `string` — The owning user ID (a user_ identifier). Provide this or account_id.
members (5) 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. - `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`.
memberships (6) 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. - `plan_id` `string` — Filter to memberships of this plan (`plan_` tag). Repeat as plan_ids[] for several. - `product_id` `string` — Filter to memberships of this product (`prod_` tag). Repeat as product_ids[] for several. - `status` `string` — Filter by billing state. `canceling` matches active memberships set to cancel at period end; `paused` matches memberships with payment collection paused. One of `active`, `trialing`, `past_due`, `completed`, `canceled`, `expired`, `canceling`, `paused`. - `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.
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 (20) Mirrors the filtering query params of `GET /api/v1/people`. - `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 whose most recent visit came 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_from` `string` — With event_to plus an event or source filter, switches to exact-population mode: person ids are resolved and paginated on the events side within this window (the same query the people metric counts), then hydrated per page. - `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 event window for exact-population mode. - `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. - `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. - `phone` `string` — Only include the person linked to this phone number. - `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. - `user_id` `string` — Only include the person linked to this whop user ID.
plans (6) Mirrors the filtering query params of `GET /api/v1/plans`. - `created_after` `string` — Only return plans created after this timestamp. - `created_before` `string` — Only return plans created before this timestamp. - `plan_types` `string[]` — Filter to only plans matching these billing types. - `product_ids` `string[]` — Filter to only plans belonging to these product identifiers. - `release_methods` `string[]` — Filter to only plans matching these release methods. - `visibilities` `string[]` — Filter to only plans matching these visibility states.
products (3) Mirrors the filtering query params of `GET /api/v1/products`. - `access_pass_types` `string[]` — Filter to only products matching these types. - `labels` `string[]` — Filter to only products carrying all of these labels. Labels are matched lowercased. - `visibilities` `string[]` — Filter to only products matching these visibility states.
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. - `plan_ids` `string[]` — Only promo codes scoped to these plan IDs. - `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`.
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 (4) Mirrors the filtering query params of `GET /api/v1/social_accounts`. - `platform` `string` — Only return social accounts for the platform that is specified. One of `x`, `instagram`, `youtube`, `tiktok`, `facebook`, `discord`, `telegram`. - `scopes` `string[]` — Only return social accounts that have these scopes. - `user_id` `string` — The User that the social accounts are connected to. Provide either this or account_id. - `verified` `boolean` — Only return social accounts that are verified on the platform.
team_members (5) 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. - `role` `string` — Only return members with this role. `custom` matches members on a dashboard-managed custom role. One of `owner`, `admin`, `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`. - `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. Provide this or origin_id. - `origin_id` `string` — Filter to transfers sent from this account. Provide this or destination_id.
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: origin_id: ldgr_x 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 - financial-activity - members - memberships - payout_methods - payouts - people - plans - products - resolution_center_cases - shipments - social_accounts - team_members - transfers - webhooks - receipts - unclaimed_memberships - tracking_links - promo_codes - resolutions - entries - leads - content_rewards_submissions - invoices - cancelation_reasons - child_companies example: transfers 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 - bearerAuth: - company:basic:read - member:basic:read - member:journey:read - bearerAuth: - content_rewards:basic:export - bearerAuth: - developer:basic:read - bearerAuth: - developer:manage_webhook - bearerAuth: - invoice:basic:export - bearerAuth: - lead:basic:export - bearerAuth: - member:basic:export - bearerAuth: - member:basic:read - bearerAuth: - 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: 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 _export = await client.exports.create({ resource: 'transfers' }); console.log(_export.id); components: parameters: ApiVersionDate: description: Pins the request to a dated API version. in: header name: Api-Version-Date required: false schema: example: '2026-08-21' 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 CSV. `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 CSV 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 - financial-activity - members - memberships - payout_methods - payouts - people - plans - products - resolution_center_cases - shipments - social_accounts - team_members - transfers - webhooks - receipts - unclaimed_memberships - tracking_links - promo_codes - resolutions - entries - leads - content_rewards_submissions - invoices - cancelation_reasons - child_companies - ledger_lines - withdrawal_lines example: members type: string status: description: >- `pending` or `processing` while the CSV is generated, `completed` when the download is ready, `failed` if it errored, `expired` once the CSV 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, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with `Bearer`, for example `Bearer ***************************`. scheme: bearer type: http ````