Skip to main content
GET
JavaScript

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

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-18"

Query Parameters

account_id
string

The account the ads belong to. Defaults to the account-scoped key's own account.

ad_campaign_id
string

Only return ads in this ad campaign.

ad_group_id
string

Only return ads in this ad group.

status
enum<string>

Only return ads with this status.

Available options:
active,
paused,
in_review,
rejected
query
string

Filter ads by a title or ID substring.

order
enum<string>

The field to sort by. Defaults to created_at. Stat columns (spend, impressions, …) rank over the stats_from/stats_to window across the whole list, not just the current page. results, cost_per_result and return_on_ad_spend rank by the same Whop pixel-attributed values the response reports.

Available options:
created_at,
updated_at,
spend,
impressions,
reach,
clicks,
unique_clicks,
frequency,
click_through_rate,
results,
cost_per_mille,
cost_per_click,
cost_per_result,
return_on_ad_spend
direction
enum<string>

The sort direction. Defaults to desc.

Available options:
asc,
desc
created_before
string

Only return ads created before this timestamp.

created_after
string

Only return ads created after this timestamp.

stats_from
string

Start of the stats window. Defaults to all-time.

stats_to
string

End of the stats window. Defaults to now.

time_zone
string

IANA timezone (e.g. America/New_York) the stats window is interpreted in. Bare stats_from/stats_to dates resolve to day boundaries on this clock. Defaults to UTC.

first
integer
default:20

The number of ads to return.

Required range: x <= 100
after
string

Cursor to fetch the page after (from page_info.end_cursor).

last
integer

The number of ads to return from the end of the range.

Required range: x <= 100
before
string

Cursor to fetch the page before (from page_info.start_cursor).

Response

ads listed

data
object[]
required
page_info
object
required