> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve an Ad Group > Retrieves a single ad group. ## OpenAPI ````yaml /openapi/api-v1-native.json get /ad_groups/{id} openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: 2026-07-08-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, 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: > 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 account time series for reporting. - description: > A Ledger Activity row is a single financial event on an account's ledger — a payment, withdrawal, refund, transfer, on-chain deposit, swap, or card transaction. Each row is derived from the underlying ledger lines and carries a typed `resource` and `source` so you can present and link the event without extra lookups. Use Ledger Activity to build a statement or transaction feed for an account or user. Reconcile against your own records with `amount` (signed, in the currency's smallest precision units) and `posted_at`, and use `available_at` to know when inflows became withdrawable. name: Ledgers x-whop-summary: The activity feed behind an account or user's balance. - description: > Payouts represent money sent from an account or user balance to an external destination, such as a bank account, wallet, or other saved payout method. Use the Payouts API to create payouts from stablecoin accounts, list payout history for accounts or users, monitor payout statuses, and show expected arrival details for funds leaving Whop. name: Payouts x-whop-summary: Send money from a balance to a bank or wallet. - description: > Cards represent Whop-issued virtual payment cards that spend from an account or user balance. Cards can be assigned to cardholders and configured with spending limits for controlled spending. Use the Cards API to issue cards, list cards for an account or user, and retrieve active card details such as the card number and CVC. name: Cards x-whop-summary: Issue cards that spend from a balance. - description: > Transfers move value between identities on Whop. They are used for account-to-account money movement, user payouts inside Whop, crypto transfers, and claim links depending on the destination type. Use the Transfers API to create a transfer, list previous transfers, and retrieve a transfer by ID when reconciling money movement between accounts or users. name: Transfers x-whop-summary: Move funds between Whop accounts and users. - description: > Deposits describe ways to add funds to an account balance, including hosted deposit pages, bank deposit instructions, and supported crypto wallet addresses. Use the Deposits API to create deposit instructions for an account and retrieve existing bank deposit activity. 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 Verification represents an identity review 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: Identity review required before payouts and card issuing. - description: > A Product is a digital good or service sold on Whop. Products may contain plans for pricing and/or experiences for content delivery. Use the Products API to create products, list products visible to your credentials, retrieve product details, update product metadata or merchandising fields, and delete products that should no longer be sold. name: Products x-whop-summary: The things you sell. Each owns plans and a store page. - description: > A Plan defines how customers buy a product. It controls pricing, billing cadence, availability, tax behavior, checkout fields, and purchase visibility. Use the Plans API to create plans for products, list existing plans, retrieve or update plan configuration, calculate tax for checkout, and delete plans that should no longer be offered. name: Plans x-whop-summary: 'Pricing for a product: one-time, recurring, trials, stock.' - description: > A Checkout Configuration is a reusable checkout link owned by an account. In `payment` mode it sells a specific plan; in `setup` mode it collects and saves payment details without charging. Each configuration can also override which payment methods are accepted and how 3D Secure is enforced for that checkout. Use the Checkout Configurations API to create checkout links for an existing or inline plan, list configurations for an account, retrieve the configuration behind a checkout URL, and delete links that should no longer be used. name: Checkout Configurations x-whop-summary: Turn a plan into a shareable, prefilled checkout link. - description: > The Referrals 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 Workforce 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 Workforce Bounties API to 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: Workforce Bounties x-whop-summary: Paid tasks with reviewed submissions and escrowed rewards. - description: > A Person represents a visitor or customer of an account, assembled from [pixel events](/api-reference/beta/events/event) and purchase activity — ad clicks, storefront visits, and checkouts. Use the People API to list the people of an account and retrieve a single person. name: People x-whop-summary: Visitors and customers of an account, aggregated from pixel events. - 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 and list the events recorded for a person. name: Events x-whop-summary: Conversion and engagement events tracked for attribution. - description: > An Ad is the individual creative unit delivered by an [ad group](/api-reference/beta/ad-groups/ad-group). It holds the copy, creative assets, and destination URL for one ad. Use the Ads API to list ads for an account, create ads inside ad groups, retrieve or update creative details, delete ads that should stop running, and pause or resume delivery. name: Ads x-whop-summary: 'The creative: copy, assets, and destination URL.' - description: > An Ad Campaign is the top-level container for paid ads on an ad network. It sets the platform, objective, and budget strategy shared by its [ad groups](/api-reference/beta/ad-groups/ad-group) and ads. Use the Ad Campaigns API to create campaigns, list campaigns for an account, retrieve or update campaign settings, and pause or resume campaign delivery. name: Ad Campaigns x-whop-summary: Platform, objective, and budget for a set of ads. - description: > An Ad Group sits inside an [ad campaign](/api-reference/beta/ad-campaigns/ad-campaign) and controls delivery for [ads](/api-reference/beta/ads/ad). It sets the audience, placements, schedule, budget, and optimization goal for its ads. Use the Ad Groups API to create ad groups in campaigns, list or retrieve targeting and delivery settings, update budgets or targeting, delete groups that should stop running, and pause or resume delivery. 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. name: Social Accounts x-whop-summary: Connected Facebook and Instagram accounts that run ads. - description: > An App is software you build on Whop. It can be a hosted web app served at `.whop.app` or an API integration installed as an experience, and it belongs to the account that owns its credentials, settings, builds, and runtime logs. Use the Apps API to manage app configuration and, for hosted apps, read server runtime logs for console output, uncaught exceptions, and failed requests. Logs are retained for 7 days and can be filtered by build, level, time window, and message text. name: Apps x-whop-summary: 'Apps you build on Whop: metadata, hosted builds, runtime logs.' paths: /ad_groups/{id}: parameters: - $ref: '#/components/parameters/ApiVersionDate' - description: The ad group ID. in: path name: id required: true schema: type: string get: tags: - Ad Groups summary: Retrieve an Ad Group description: Retrieves a single ad group. operationId: retrieveAdGroup parameters: - description: Start of the stats window. in: query name: stats_from required: false schema: type: string - description: End of the stats window. in: query name: stats_to required: false schema: type: string - description: IANA timezone the stats window is interpreted in. Defaults to UTC. in: query name: time_zone required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdGroup' description: ad group retrieved '404': $ref: '#/components/responses/NotFound' description: ad group not found security: - bearerAuth: - ad_campaign:basic:read components: parameters: ApiVersionDate: description: Pins the request to a dated API version. in: header name: Api-Version-Date required: false schema: example: 2026-07-08-1 type: string schemas: AdGroup: properties: ad_campaign: $ref: '#/components/schemas/AdEntityReference' description: The ad campaign this ad group belongs to, an object with an id. added_to_carts: description: Whop pixel-attributed add-to-cart events, last-click. type: number audiences: description: >- Saved-audience targeting: { include, exclude } arrays of audience IDs. type: object bid_type: description: Bid strategy. enum: - minimum_cost - average_target - maximum_target - null example: minimum_cost type: - string - 'null' budget_amount: description: Ad-set budget; null when the campaign owns budget (CBO). type: - number - 'null' budget_type: description: Whether the budget is daily or lifetime. enum: - daily - lifetime - null example: daily type: - string - 'null' click_through_rate: description: Clicks divided by impressions, between 0 and 1. type: number clicks: description: The number of clicks. type: number completed_registrations: description: Whop pixel-attributed complete-registration events, last-click. type: number contacts: description: Whop pixel-attributed contact events, last-click. type: number conversion_event: $ref: '#/components/schemas/ConversionEvent' conversion_location: description: >- Where results happen: website, profile (IG/FB), messaging (DM), on_ad (engagement), or the lead destinations (instant_forms, instant_forms_and_messenger, website_and_instant_forms). enum: - website - profile - messaging - on_ad - instant_forms - instant_forms_and_messenger - website_and_instant_forms - null example: website type: - string - 'null' cost_per_added_to_cart: description: >- Spend divided by attributed add-to-cart events; null when they are not the goal and none are attributed. type: - number - 'null' cost_per_click: description: Spend divided by clicks; 0 when there are no clicks. type: number cost_per_completed_registration: description: >- Spend divided by attributed complete-registration events; null when they are not the goal and none are attributed. type: - number - 'null' cost_per_contact: description: >- Spend divided by attributed contact events; null when contacts are not the goal and none are attributed. type: - number - 'null' cost_per_lead: description: >- Spend divided by attributed leads; null when leads are not a goal and none are attributed. type: - number - 'null' cost_per_mille: description: Spend per 1,000 impressions; 0 when there are no impressions. type: number cost_per_purchase: description: >- Spend divided by attributed purchases; null when purchases are not a goal and none are attributed. type: - number - 'null' cost_per_result: description: >- Spend divided by Whop pixel-attributed results; null when nothing Whop-attributable is being optimized for. type: - number - 'null' cost_per_schedule: description: >- Spend divided by attributed schedule events; null when schedules are not the goal and none are attributed. type: - number - 'null' cost_per_submitted_application: description: >- Spend divided by attributed submit-application events; null when they are not the goal and none are attributed. type: - number - 'null' cost_per_viewed_content: description: >- Spend divided by attributed view-content events; null when they are not the goal and none are attributed. type: - number - 'null' created_at: description: When the ad group was created, ISO 8601. type: string custom_conversions: description: >- Whop pixel-attributed custom (merchant-defined) conversion events, last-click, across all custom event names. type: number custom_event_counts: description: >- Whop pixel-attributed custom conversions broken out by merchant-defined event name, last-click, as a { event_name => count } map over the stats window. Empty when no named custom events are attributed. Custom events fired without a name are counted in custom_conversions but omitted here, so these values sum to at most custom_conversions. type: object delivery_status: description: >- The current delivery state, mirroring the Delivery column in the ads dashboard. When several states apply at once, the highest-precedence one is returned. enum: - all_ads_rejected - rejected - draft - no_ads - campaign_paused - paused - processing - issues - scheduled - completed - ads_off - learning_limited - learning - active example: all_ads_rejected type: string demographics: description: 'Demographic targeting: automatic (Advantage+), age range, gender.' type: object desired_cost_per_result: description: Target/cap cost for average_target / maximum_target. type: - number - 'null' devices: description: 'Device targeting: platforms and operating systems.' type: object dynamic_creative: description: >- Whether ads within this ad group have their creatives and copy dynamically AB tested. type: boolean ends_at: description: Schedule end, ISO 8601. type: - string - 'null' frequency: description: Platform-reported impressions divided by reach. type: - number - 'null' frequency_cap: description: Impression cap; only valid for reach optimization. type: - object - 'null' id: description: Unique identifier for the ad group. type: string impressions: description: The number of impressions. type: number issues: items: $ref: '#/components/schemas/AdPlatformIssue' description: >- Open issues affecting this ad group and its descendant ads. Empty when there are none. type: array languages: items: description: >- Targeted languages as ISO 639 codes (e.g. en, es). Region-specific Meta locales without an ISO mapping appear as their numeric Meta locale key. Empty = all languages. type: string type: array leads: description: Whop pixel-attributed leads, last-click. type: number message_apps: items: description: >- For messaging destinations: the apps to message on (messenger, instagram, whatsapp). Empty otherwise. type: string type: array minimum_daily_spend: description: Daily spend floor within the budget. type: - number - 'null' optimization_goal: description: What the ad group optimizes for. type: - string - 'null' placements: items: description: >- Targeted placements as { platform, positions }. Empty = automatic (Advantage+) placements. type: object type: array purchase_value: description: USD value of pixel-attributed purchases. type: number purchases: description: Whop pixel-attributed purchases, last-click. type: number reach: description: The number of unique people who saw this. type: number regions: description: >- Geo targeting: include/exclude countries, regions (ISO 3166-2 states, e.g. US-CA), cities, zips. type: object result_event: description: >- The Whop pixel conversion event whose attributed count represents results — the optimization goal, or the highest-volume attributed event for campaigns that budget per ad group. Null when the goal isn't a Whop-attributed event. enum: - purchase - lead - schedule - submit_application - contact - complete_registration - view_content - add_to_cart - custom - null example: purchase type: - string - 'null' result_event_name: description: >- The merchant-defined event name when result_event is custom; null for the standard events. type: - string - 'null' results: description: >- The Whop pixel-attributed count behind result_event. When a campaign's ad groups optimize different goals there is no single result_event (it is null), and this is instead the sum of each ad group's own attributed results. Null when nothing Whop-attributable is being optimized for. type: - number - 'null' return_on_ad_spend: description: >- Purchase value divided by spend, both in USD (a currency-neutral ratio); 0 when there is no spend. type: number schedules: description: Whop pixel-attributed schedule events, last-click. type: number spend: description: The amount charged, in spend_currency. type: number spend_currency: description: The ISO 4217 currency code of all monetary metrics. type: - string - 'null' starts_at: description: Schedule start, ISO 8601. type: - string - 'null' status: description: Delivery status of the ad group. enum: - active - paused - rejected example: active type: string submitted_applications: description: Whop pixel-attributed submit-application events, last-click. type: number title: description: The display title of the ad group. type: - string - 'null' unique_click_through_rate: description: Unique clicks divided by impressions, between 0 and 1. type: - number - 'null' unique_clicks: description: The number of unique clicks. type: number updated_at: description: When the ad group was last updated, ISO 8601. type: string viewed_contents: description: Whop pixel-attributed view-content events, last-click. type: number required: - click_through_rate - clicks - cost_per_click - cost_per_lead - cost_per_mille - cost_per_purchase - cost_per_schedule - cost_per_submitted_application - cost_per_contact - cost_per_completed_registration - cost_per_viewed_content - cost_per_added_to_cart - cost_per_result - frequency - impressions - leads - purchase_value - purchases - reach - result_event - result_event_name - results - return_on_ad_spend - spend - spend_currency - unique_click_through_rate - unique_clicks - schedules - submitted_applications - contacts - completed_registrations - viewed_contents - added_to_carts - custom_conversions - custom_event_counts - id - title - status - delivery_status - optimization_goal - conversion_location - message_apps - conversion_event - budget_amount - budget_type - minimum_daily_spend - bid_type - desired_cost_per_result - starts_at - ends_at - regions - demographics - audiences - languages - dynamic_creative - devices - frequency_cap - placements - ad_campaign - created_at - updated_at - issues type: object AdEntityReference: properties: id: description: The referenced entity's id. type: string required: - id type: object ConversionEvent: anyOf: - enum: - purchase - add_to_cart - initiated_checkout - add_payment_info - complete_registration - lead - content_view - search - contact - customize_product - donate - find_location - schedule - start_trial - submit_application - subscribe type: string - type: string - type: 'null' description: >- The pixel event optimized for. A standard event, or any custom pixel event name. AdPlatformIssue: properties: id: description: Unique identifier for the issue. type: string message: description: A description of what the issue is and how it can be resolved. type: string resource_id: description: The ID of the campaign, ad group, or ad the issue is attached to. type: - string - 'null' resource_type: description: The type of resource the issue is attached to. enum: - ad_campaign - ad_group - ad example: ad_campaign type: string required: - id - message - resource_id - resource_type type: object V1ErrorResponse: properties: error: properties: message: description: Human-readable error message. type: string type: description: Machine-readable error code. type: string required: - type - message type: object required: - error type: object responses: NotFound: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Resource not found securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like `Bearer ***************************` scheme: bearer type: http ````