Create Export

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.

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.

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.

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.
• 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.

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.

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.

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.

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.

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 variant ID, prefixed plan_.

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. Inquiries match only the warning_ statuses. A needs_response dispute whose evidence deadline has passed reports and filters as under_review instead.

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.

Mirrors the filtering query params of GET /api/v1/external_accounts.

• platform string — Only return external accounts for the platform that is specified. One of x, instagram, youtube, tiktok, facebook, discord, telegram, linkedin, snapchat.
• 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, 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.

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.

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, plan_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.
• plan_ids string[] — Only return members holding a membership on one of these plans, prefixed plan_. Unknown IDs match nothing.
• 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.

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.
• 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.
• plan_id string — Filter to memberships of this variant (plan_ tag).
• plan_ids string[] — Filter to memberships of any of these variants, each prefixed plan_. Repeat the parameter to pass several.
• 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.

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.

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.

Mirrors the filtering query params of GET /api/v1/products.

• access_pass_types string[] — Filter to only products matching these types.
• 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.
• plan_types string[] — Filter to products with a buyable variant of these billing models, such as one_time or renewal.
• price_maximum number — Only return products whose advertised buyable variant has a displayed price of at most this amount. Recurring variants use renewal price.
• price_minimum number — Only return products whose advertised buyable variant has a displayed price of at least this amount. Recurring variants use renewal price.
• 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.

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 variant 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.

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.

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.

Mirrors the filtering query params of GET /api/v1/social_accounts.

• platform string — Only return external accounts for the platform that is specified. One of x, instagram, youtube, tiktok, facebook, discord, telegram, linkedin, snapchat.
• 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, 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.

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.
• 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, prefixed ausr_. 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.
• user_id string — Only return the membership for this user ID, prefixed user_.

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.

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.