List your Pinterest ad campaigns — objective, budget
pinterest-ads.campaignsList the campaigns in your Pinterest ad account with objective, status and budget
- 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.campaignsPreviewTry onlineComing soonProvider docs ↗
- Uses platform quota
- Synchronous response
- Reads public data
Parameters
budgets are in MICRO-CURRENCY: daily_spend_cap 5000000 is $5.00. objective_type is AWARENESS | CONSIDERATION | VIDEO_VIEW | WEB_CONVERSION | CATALOG_SALES | WEB_SESSIONS
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Path parameters | ||||
ad_account_id | string | Required | 549755885175 | |
| Query parameters | ||||
order | string | Optional | ASCENDING | DESCENDING by id | |
bookmark | string | Optional | ||
page_size | integer | Optional | max 250 | 25 |
campaign_ids | array | Optional | comma-separated ids; mutually exclusive with entity_statuses | |
entity_statuses | array | Optional | ACTIVE | PAUSED | ARCHIVED — defaults to ACTIVE and PAUSED, so archived campaigns are hidden unless asked for | ["ACTIVE"] |
- Path parameters
ad_account_idstringRequiredExample:
549755885175- Query parameters
orderstringOptionalASCENDING | DESCENDING by id
bookmarkstringOptionalpage_sizeintegerOptionalmax 250
Example:
25campaign_idsarrayOptionalcomma-separated ids; mutually exclusive with entity_statuses
entity_statusesarrayOptionalACTIVE | PAUSED | ARCHIVED — defaults to ACTIVE and PAUSED, so archived campaigns are hidden unless asked for
Example:
["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.campaigns' \
-H "X-Toolswitch-Key: $TOOLSWITCH_KEY"import os
import requests
response = requests.request(
"GET",
"https://toolswitch.dev/v1/tools/pinterest-ads.campaigns",
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.campaigns", {
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.