Skip to main content
GET
/
ads
/
{id}
Retrieve ad
curl --request GET \
  --url https://api.whop.com/api/v1/ads/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
  },
  "external_ad_group": {
    "id": "adgrp_xxxxxxxxxxxx",
    "name": "<string>",
    "status": "active"
  },
  "external_ad_creative_set": {
    "id": "adcs_xxxxxxxxxxxxx"
  }
}

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

Path Parameters

​
id
string
required

The unique identifier of the ad.

Example:

"xad_xxxxxxxxxxxxxx"

Response

A successful response

An ad belonging to an ad group

​
id
string
required

Unique identifier for the ad.

Example:

"xad_xxxxxxxxxxxxxx"

​
status
enum<string>
required

Current status of the ad.

Available options:
active,
paused,
inactive
​
created_at
string<date-time>
required

When the ad was created.

Example:

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

​
updated_at
string<date-time>
required

When the ad was last updated.

Example:

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

​
platform_config
MetaAdPlatformConfigType · object
required

Meta (Facebook/Instagram) ad configuration.

​
external_ad_group
object
required

The parent ad group.

​
external_ad_creative_set
object
required

The creative set used by this ad.