List your Pinterest ads — promoted Pins, destinations
pinterest-ads.adsList the ads in your Pinterest ad account with their promoted Pins and destinations
- Price
- freeAt provider cost
- Success rate
- —No success-rate data yetNo success-rate data yet
- Latency p50
- ——
- Last verified
- —Not verified yet
GEThttps://toolswitch.dev/v1/tools/pinterest-ads.adsPreviewTry onlineComing soonProvider docs ↗
- Uses platform quota
- Synchronous response
- Reads public data
Parameters
a Pinterest ad is a promoted Pin: the creative itself is `pin_id`, which you resolve through GET /pins/{pin_id} for the image and description. destination_url and creative_type (REGULAR | VIDEO | CAROUSEL | IDEA | COLLECTION) are on the ad
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Path parameters | ||||
ad_account_id | string | Required | 549755885175 | |
| Query parameters | ||||
ad_ids | array | Optional | ||
bookmark | string | Optional | ||
page_size | integer | Optional | 25 | |
ad_group_ids | array | Optional | ||
campaign_ids | array | Optional | ||
entity_statuses | array | Optional | ["ACTIVE"] | |
- Path parameters
ad_account_idstringRequiredExample:
549755885175- Query parameters
ad_idsarrayOptionalbookmarkstringOptionalpage_sizeintegerOptionalExample:
25ad_group_idsarrayOptionalcampaign_idsarrayOptionalentity_statusesarrayOptionalExample:
["ACTIVE"]
Code samples
Replace $TOOLSWITCH_KEY with the key you created in the console.
Preview
curl -X GET 'https://toolswitch.dev/v1/tools/pinterest-ads.ads' \
-H "X-Toolswitch-Key: $TOOLSWITCH_KEY"import os
import requests
response = requests.request(
"GET",
"https://toolswitch.dev/v1/tools/pinterest-ads.ads",
headers={"X-Toolswitch-Key": os.environ["TOOLSWITCH_KEY"]},
)
response.raise_for_status()
print(response.text)const response = await fetch("https://toolswitch.dev/v1/tools/pinterest-ads.ads", {
method: "GET",
headers: {
"X-Toolswitch-Key": process.env.TOOLSWITCH_KEY ?? "",
},
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
console.log(await response.text());This gateway API is in preview; its URL and authentication may change. The example parameters are sample data. Calls are billed at free, including the service fee.