> ## 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. # List ads > List ads scoped by ad group, campaign, or company. Required permissions: - `ad_campaign:basic:read` ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/whopsdk/openapi.documented.yml get /ads openapi: 3.1.0 info: title: Whop API 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/ version: 1.0.0 servers: - url: https://api.whop.com/api/v1 description: Production Whop API security: [] tags: - name: Products description: Products - name: Plans description: Plans - name: Payments description: Payments - name: Refunds description: Refunds - name: Disputes description: Disputes - name: Dispute alerts description: Dispute alerts - name: Resolution center cases description: Resolution center cases - name: Checkout configurations description: Checkout configurations - name: Setup intents description: Setup intents - name: Payment methods description: Payment methods - name: Invoices description: Invoices - name: Promo codes description: Promo codes - name: Card transactions description: Card transactions - name: Ledger accounts description: Ledger accounts - name: Transfers description: Transfers - name: Withdrawals description: Withdrawals - name: Payout methods description: Payout methods - name: Verifications description: Verifications - name: Payout accounts description: Payout accounts - name: Topups description: Topups - name: Users description: Users - name: Companies description: Companies - name: Authorized users description: Authorized users - name: Fee markups description: Fee markups - name: Members description: Members - name: Memberships description: Memberships - name: Leads description: Leads - name: Entries description: Entries - name: Shipments description: Shipments - name: Reviews description: Reviews - name: Company token transactions description: Company token transactions - name: Affiliates description: Affiliates - name: Experiences description: Experiences - name: Forums description: Forums - name: Forum posts description: Forum posts - name: Chat channels description: Chat channels - name: Support channels description: Support channels - name: Messages description: Messages - name: Reactions description: Reactions - name: Dm members description: Dm members - name: Dm channels description: Dm channels - name: Notifications description: Notifications - name: Courses description: Courses - name: Course chapters description: Course chapters - name: Course lessons description: Course lessons - name: Course students description: Course students - name: Course lesson interactions description: Course lesson interactions - name: Apps description: Apps - name: Webhooks description: Webhooks - name: App builds description: App builds - name: Access tokens description: Access tokens - name: Account links description: Account links - name: Files description: Files - name: Ai chats description: Ai chats - name: Bounties description: Bounties - name: Stats description: Stats - name: Ad campaigns description: Ad campaigns - name: Ad groups description: Ad groups - name: Ads description: Ads - name: Conversions description: Conversions paths: /ads: get: tags: - Ads summary: List ads description: |- List ads scoped by ad group, campaign, or company. Required permissions: - `ad_campaign:basic:read` operationId: listAd parameters: - name: after in: query required: false schema: type: - string - 'null' description: >- Returns the elements in the list that come after the specified cursor. explode: true style: form - name: before in: query required: false schema: type: - string - 'null' description: >- Returns the elements in the list that come before the specified cursor. explode: true style: form - name: first in: query required: false schema: type: - integer - 'null' description: Returns the first _n_ elements from the list. example: 42 explode: true style: form - name: last in: query required: false schema: type: - integer - 'null' description: Returns the last _n_ elements from the list. example: 42 explode: true style: form - name: ad_group_id in: query required: false schema: type: - string - 'null' description: >- Filter by ad group. Provide exactly one of ad_group_id, campaign_id, or company_id. explode: true style: form - name: campaign_id in: query required: false schema: type: - string - 'null' description: >- Filter by campaign. Provide exactly one of ad_group_id, campaign_id, or company_id. explode: true style: form - name: company_id in: query required: false schema: type: - string - 'null' description: >- Filter by company. Provide exactly one of ad_group_id, campaign_id, or company_id. example: biz_xxxxxxxxxxxxxx explode: true style: form - name: created_after in: query required: false schema: type: - string - 'null' format: date-time description: Only return ads created after this timestamp. example: '2023-12-01T05:00:00.401Z' explode: true style: form - name: created_before in: query required: false schema: type: - string - 'null' format: date-time description: Only return ads created before this timestamp. example: '2023-12-01T05:00:00.401Z' explode: true style: form - name: status in: query required: false schema: oneOf: - $ref: '#/components/schemas/ExternalAdStatuses' - type: 'null' description: Filter by status. explode: true style: form responses: '200': description: A successful response content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/AdListItem' description: A list of nodes. page_info: $ref: '#/components/schemas/PageInfo' description: Information to aid in pagination. required: - data - page_info description: The connection type for ExternalAd. '400': description: Bad request content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: invalid_request_error code: parameter_missing message: 'Missing required parameter: amount.' param: amount '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: unauthorized message: Invalid or missing API key '403': description: Forbidden content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: forbidden message: You do not have permission to access this resource '404': description: Not found content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: not_found message: Resource not found '422': description: Verification required content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: null '500': description: Internal server error content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: internal_server_error message: An unexpected error occurred security: - bearerAuth: - ad_campaign:basic:read 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 }); // Automatically fetches more pages as needed. for await (const adListResponse of client.ads.list()) { console.log(adListResponse.id); } - lang: Python source: |- import os from whop_sdk import Whop client = Whop( api_key=os.environ.get("WHOP_API_KEY"), # This is the default and can be omitted ) page = client.ads.list() page = page.data[0] print(page.id) - lang: Ruby source: |- require "whop_sdk" whop = WhopSDK::Client.new(api_key: "My API Key") page = whop.ads.list puts(page) components: schemas: ExternalAdStatuses: type: string enum: - active - paused - inactive - in_review - rejected - flagged description: The status of an external ad. AdListItem: type: object properties: id: type: string description: Unique identifier for the ad. example: xad_xxxxxxxxxxxxxx status: $ref: '#/components/schemas/ExternalAdStatuses' description: Current status of the ad. created_at: type: string format: date-time description: When the ad was created. example: '2023-12-01T05:00:00.401Z' updated_at: type: string format: date-time description: When the ad was last updated. example: '2023-12-01T05:00:00.401Z' platform_config: type: - object - 'null' oneOf: - type: - object - 'null' properties: typename: type: string const: MetaAdPlatformConfigType description: The typename of this object platform: $ref: '#/components/schemas/AdCampaignPlatforms' description: The ad platform. name: type: - string - 'null' description: >- Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. link_url: type: - string - 'null' description: >- Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. url_tags: type: - string - 'null' description: >- Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. primary_text: type: - string - 'null' description: >- Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. headline: type: - string - 'null' description: >- Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. call_to_action_type: oneOf: - $ref: >- #/components/schemas/MetaAdPlatformConfigCallToActionType - type: 'null' page_id: type: - string - 'null' description: >- Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. instagram_actor_id: type: - string - 'null' description: >- Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. required: - typename - platform - name - link_url - url_tags - primary_text - headline - call_to_action_type - page_id - instagram_actor_id description: Meta (Facebook/Instagram) ad configuration. title: MetaAdPlatformConfigType - type: - object - 'null' properties: typename: type: string const: TiktokAdPlatformConfigType description: The typename of this object platform: $ref: '#/components/schemas/AdCampaignPlatforms' description: The ad platform. ad_name: type: - string - 'null' description: >- Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. ad_format: oneOf: - $ref: '#/components/schemas/TiktokAdPlatformConfigAdFormat' - type: 'null' identity_type: oneOf: - $ref: '#/components/schemas/TiktokAdPlatformConfigIdentityType' - type: 'null' identity_id: type: - string - 'null' description: >- Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. identity_authorized_bc_id: type: - string - 'null' description: >- Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. video_id: type: - string - 'null' description: >- Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. image_ids: type: - array - 'null' items: type: string description: >- Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. ad_text: type: - string - 'null' description: >- Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. call_to_action: oneOf: - $ref: '#/components/schemas/TiktokCallToAction' - type: 'null' landing_page_url: type: - string - 'null' description: >- Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. required: - typename - platform - ad_name - ad_format - identity_type - identity_id - identity_authorized_bc_id - video_id - image_ids - ad_text - call_to_action - landing_page_url description: TikTok ad configuration. title: TiktokAdPlatformConfigType discriminator: propertyName: typename description: Typed platform-specific configuration. required: - id - status - created_at - updated_at - platform_config description: An ad belonging to an ad group PageInfo: type: object properties: end_cursor: type: - string - 'null' description: When paginating forwards, the cursor to continue. start_cursor: type: - string - 'null' description: When paginating backwards, the cursor to continue. has_next_page: type: boolean description: When paginating forwards, are there more items? has_previous_page: type: boolean description: When paginating backwards, are there more items? required: - end_cursor - start_cursor - has_next_page - has_previous_page description: Information about pagination in a connection. AdCampaignPlatforms: type: string enum: - meta - tiktok description: The platforms where an ad campaign can run. MetaAdPlatformConfigCallToActionType: type: string enum: - LEARN_MORE - SHOP_NOW - SIGN_UP - SUBSCRIBE - GET_STARTED - BOOK_NOW - APPLY_NOW - CONTACT_US - DOWNLOAD - ORDER_NOW - BUY_NOW - GET_QUOTE - MESSAGE_PAGE - WHATSAPP_MESSAGE - INSTAGRAM_MESSAGE - CALL_NOW - GET_DIRECTIONS - SEND_UPDATES - GET_OFFER - WATCH_MORE - LISTEN_NOW - PLAY_GAME - OPEN_LINK - NO_BUTTON - GET_OFFER_VIEW - GET_EVENT_TICKETS - SEE_MENU - REQUEST_TIME - EVENT_RSVP - SEE_DETAILS - VIEW_INSTAGRAM_PROFILE TiktokAdPlatformConfigAdFormat: type: string enum: - SINGLE_IMAGE - SINGLE_VIDEO - CAROUSEL_ADS - CATALOG_CAROUSEL - LIVE_CONTENT TiktokAdPlatformConfigIdentityType: type: string enum: - CUSTOMIZED_USER - AUTH_CODE - TT_USER - BC_AUTH_TT TiktokCallToAction: type: string enum: - LEARN_MORE - DOWNLOAD - SHOP_NOW - SIGN_UP - CONTACT_US - APPLY_NOW - BOOK_NOW - PLAY_GAME - WATCH_NOW - READ_MORE - VIEW_NOW - GET_QUOTE - ORDER_NOW - INSTALL_NOW - GET_SHOWTIMES - LISTEN_NOW - INTERESTED - SUBSCRIBE - GET_TICKETS_NOW - EXPERIENCE_NOW - PRE_ORDER_NOW - VISIT_STORE description: >- TikTok call-to-action button text. See docs/tiktok_api/ad.md ยง call_to_action. securitySchemes: bearerAuth: type: http 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 bearerFormat: auth-scheme ````