Lists campaigns for a Pinterest Ads account with status, objective, spend caps, and schedule details
Lists campaigns for a Pinterest Ads account with status, objective, spend caps, and schedule details. Supports filtering by status, campaign IDs, or by name and ID. Note: spend caps and budgets are returned in Pinterest microcurrency (divide by 1,000,000 for the account currency).
Select the Pinterest Ads account whose campaigns should be listed.
entity_statuses
array of string or SelectableOption
No
-
Filter campaigns by status. Options: ACTIVE, PAUSED, ARCHIVED, DRAFT. Defaults to ACTIVE and PAUSED when omitted.
campaign_ids
array of string (also accepts a comma-separated string)
No
-
Optional campaign IDs to fetch, as a list or comma-separated text.
filters
array of FilterItem
No
-
Additional filters to apply when retrieving campaigns. The available fields to filter by are: - id: Filter by campaign ID - name: Filter by campaign name Filters are combined using AND logic. If you want to use OR logic, use relevant operators like REGEXP_MATCH or IN_LIST.
limit
integer
No
100
Maximum number of campaigns to return. Default: 100.
The field to filter on, must be one of the current selected metrics or dimensions.
operator
string
Yes
-
The operator to use for filtering. Must be one of the supported values. Use REGEXP_MATCH to search/filter by multiple OR values like ’.(summer|holiday).’
value
string
Yes
-
The value to filter by, always as a string: text, a number, or a regex. For IN_LIST and NOT_IN_LIST, pass the values as one comma-separated string such as ‘a,b,c’, not as an array. For regex values, escape backslashes once in the JSON string: write \b for a word boundary, not \b.