Skip to main content
GET
/
ads
List ads
curl --request GET \
  --url https://api.whop.com/api/v1/ads \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "xad_xxxxxxxxxxxxxx",
      "status": "active",
      "created_at": "2023-12-01T05:00:00.401Z",
      "updated_at": "2023-12-01T05:00:00.401Z",
      "platform_config": {
        "typename": "<string>",
        "platform": "meta",
        "name": "<string>",
        "link_url": "<string>",
        "url_tags": "<string>",
        "primary_text": "<string>",
        "headline": "<string>",
        "call_to_action_type": "LEARN_MORE",
        "page_id": "<string>",
        "instagram_actor_id": "<string>"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

​
Authorization
string
header
required

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 ***************************

Query Parameters

​
after
string | null

Returns the elements in the list that come after the specified cursor.

​
before
string | null

Returns the elements in the list that come before the specified cursor.

​
first
integer | null

Returns the first n elements from the list.

Example:

42

​
last
integer | null

Returns the last n elements from the list.

Example:

42

​
ad_group_id
string | null

Filter by ad group. Provide exactly one of ad_group_id, campaign_id, or company_id.

​
campaign_id
string | null

Filter by campaign. Provide exactly one of ad_group_id, campaign_id, or company_id.

​
company_id
string | null

Filter by company. Provide exactly one of ad_group_id, campaign_id, or company_id.

Example:

"biz_xxxxxxxxxxxxxx"

​
created_after
string<date-time> | null

Only return ads created after this timestamp.

Example:

"2023-12-01T05:00:00.401Z"

​
created_before
string<date-time> | null

Only return ads created before this timestamp.

Example:

"2023-12-01T05:00:00.401Z"

​
status
enum<string> | null

Filter by status.

Available options:
active,
paused,
inactive

Response

A successful response

The connection type for ExternalAd.

​
data
object[]
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.