Skip to main content
GET
/
ad_groups
/
{id}
Retrieve ad group
curl --request GET \
  --url https://api.whop.com/api/v1/ad_groups/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "adgrp_xxxxxxxxxxxx",
  "name": "<string>",
  "status": "active",
  "daily_budget": 6.9,
  "created_at": "2023-12-01T05:00:00.401Z",
  "updated_at": "2023-12-01T05:00:00.401Z",
  "platform_config": {
    "typename": "<string>",
    "platform": "meta",
    "page_id": "<string>",
    "instagram_actor_id": "<string>",
    "status": "ACTIVE",
    "bid_strategy": "LOWEST_COST_WITHOUT_CAP",
    "bid_amount": 42,
    "daily_budget": 42,
    "lifetime_budget": 42,
    "end_time": "<string>",
    "optimization_goal": "NONE",
    "billing_event": "APP_INSTALLS",
    "destination_type": "UNDEFINED",
    "promoted_object": {},
    "attribution_spec": [
      {}
    ],
    "publisher_platforms": [
      "<string>"
    ],
    "facebook_positions": [
      "<string>"
    ],
    "instagram_positions": [
      "<string>"
    ],
    "geo_locations": {},
    "excluded_geo_locations": {},
    "targeting_automation": {}
  },
  "config": {
    "bid_strategy": "lowest_cost",
    "bid_amount": 42,
    "optimization_goal": "conversions",
    "billing_event": "impressions",
    "start_time": "<string>",
    "end_time": "<string>",
    "pacing": "standard",
    "frequency_cap": 42,
    "frequency_cap_interval_days": 42,
    "targeting": {
      "countries": [
        "<string>"
      ],
      "age_min": 42,
      "age_max": 42,
      "genders": [
        "male"
      ],
      "languages": [
        "<string>"
      ],
      "placement_type": "automatic",
      "device_platforms": [
        "mobile"
      ],
      "interest_ids": [
        "<string>"
      ],
      "include_audience_ids": [
        "<string>"
      ],
      "exclude_audience_ids": [
        "<string>"
      ]
    }
  },
  "ad_campaign": {
    "id": "adcamp_xxxxxxxxxxx",
    "title": "<string>",
    "platform": "meta",
    "status": "active"
  }
}

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

Example:

"adgrp_xxxxxxxxxxxx"

Response

A successful response

An external ad group (ad set) belonging to an ad campaign

id
string
required

The unique identifier for the external ad group.

Example:

"adgrp_xxxxxxxxxxxx"

name
string | null
required

Human-readable ad group name

status
enum<string>
required

Current operational status of the ad group

Available options:
active,
paused,
inactive
daily_budget
number | null
required

Daily budget in dollars

Example:

6.9

created_at
string<date-time>
required

The datetime the external ad group was created.

Example:

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

updated_at
string<date-time>
required

The datetime the external ad group was last updated.

Example:

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

platform_config
MetaAdGroupPlatformConfigType · object
required

Meta (Facebook/Instagram) ad set configuration.

config
object
required

Unified ad group configuration (platform-agnostic)

ad_campaign
object
required

The parent ad campaign