Manage Pinterest boards, sections and pins, read account and pin analytics, search, trends, catalogs and ad account data.
Explore 156 workflow actions for Pinterest, including account permissions and operation limits.
121 read actions35 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Ad account analytics
Read
Get analytics for the specified ad_account_id, filtered by the specified options.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ad account countries get
Read
Get Ad Accounts countries.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ad account targeting analytics get
Read
Get targeting analytics for an ad account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ad accounts audiences shared accounts list
Read
List all ad accounts and/or businesses that have access to a specific audience.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ad accounts get
Read
Get an ad account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ad accounts list
Read
Get a list of the ad_accounts that the "operation user_account" has access to.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ad accounts subscriptions get by id
Read
Get an existing lead ads webhook subscription by ID.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ad accounts subscriptions get list
Read
Get the advertiser's list of lead ads subscriptions.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ad groups analytics
Read
Get analytics for the specified ad groups in the specified ad_account_id, filtered by the specified options.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ad groups audience sizing
Read
Get potential audience size for an ad group with given targeting criteria.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ad groups bid floor get
Read
List bid floors for your campaign configuration.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ad groups get
Read
Get a specific ad group given the ad group ID.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ad groups list
Read
List ad groups based on provided campaign IDs or ad group IDs.(campaign_ids or ad_group_ids).
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ad groups targeting analytics get
Read
Get targeting analytics for one or more ad groups.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ad pins analytics
Read
Get analytics for the pins given a campaign and pins in the specified ad_account_id, filtered by the specified options.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ad targeting analytics get
Read
Get targeting analytics for one or more ads.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ads analytics
Read
Get analytics for the specified ads in the specified ad_account_id, filtered by the specified options.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ads get
Read
Get a specific ad given the ad ID.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Ads list
Read
List ads that meet the filters provided: - Listed campaign ids or ad group ids or ad ids - Listed entity statuses If no filter is provided, all ads in the ad account are returned.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Advanced auction items get post
Read
Get the bid options for a batch of retail catalog items.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Advertiser defined events get
Read
Get advertiser defined events for the given ad account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Analytics create conversion product report
Write
[Restricted](/docs/getting-started/using-beta-and-restricted-features/) This creates an asynchronous brand, category, SKU report based on the given request.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Analytics create mmm report
Write
This creates an asynchronous mmm report based on the given request.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Analytics create report
Write
This returns a token that you can use to download the report when it is ready.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Analytics create template report
Write
This takes a template ID and an optional custom timeframe and constructs an asynchronous report based on the template.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Analytics get conversion product report
Read
[Restricted](/docs/getting-started/using-beta-and-restricted-features/) Get a brand, category, SKU report for an ad account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Analytics get mmm report
Read
Get an mmm report for an ad account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Analytics get report
Read
This returns a URL to an analytics report given a token returned from the post request report creation call.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Audience insights get
Read
Get Audience Insights for an ad account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Audience insights scope and type get
Read
Get the scope and type of available audiences, which along with a date, is an audience that has recently had an interaction (referred to here as a type) on pins.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Audiences get
Read
Get a specific audience given the audience ID.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Audiences list
Read
Get list of audiences for the ad account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Board sections create
Write
Create a board section on a board owned by the "operation user_account" - or on a group board that has been shared with this account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Board sections delete
Write
Delete a board section on a board owned by the "operation user_account" - or on a group board that has been shared with this account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Board sections list
Read
Get a list of all board sections from a board owned by the "operation user_account" - or a group board that has been shared with this account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Board sections list pins
Read
Get a list of the Pins on a board section of a board owned by the "operation user_account" - or on a group board that has been shared with this account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Board sections update
Write
Update a board section on a board owned by the "operation user_account" - or on a group board that has been shared with this account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Boards create
Write
Create a board owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Boards delete
Write
Delete a board owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Boards get
Read
Get a board owned by the operation user_account - or a group board that has been shared with this account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Boards list
Read
Get a list of the boards owned by the "operation user_account" + group boards where this account is a collaborator Optional: Business Access: Specify an ad_account_id to use the.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Boards list pins
Read
Get a list of the Pins on a board owned by the "operation user_account" - or on a group board that has been shared with this account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Boards update
Write
Update a board owned by the "operating user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Boards user follows list
Read
Get a list of the boards a user follows.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Bulk download create
Read
Create an asynchronous report that may include information on campaigns, ad groups, product groups, ads, keywords, schedules,and/or labels; can filter by campaigns.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Bulk request get
Read
Get the status of a bulk request by request_id, along with a download URL that will allow you to download the new or updated entity data (campaigns, ad groups, product groups.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Business account audiences shared accounts list
Read
List all ad accounts and/or businesses that have access to a specific audience.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Business asset members get
Read
Get all the members the requesting business has granted access to on the given asset.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Business asset partners get
Read
Get all the partners the requesting business has granted access to on the given asset.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Business assets get
Read
Get all the assets the requesting business has access to.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Business member assets get
Read
Get assets on which you assigned asset permissions to the given member.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Business partner asset access get
Read
Can be used to get the business assets your partner has granted you access to or the business assets you have granted your partner access to.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Campaign ad preview read
Read
Fetch ad preview records for one or more ad groups.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Campaign targeting analytics get
Read
Get targeting analytics for one or more campaigns.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Campaigns analytics
Read
Get analytics for the specified campaigns in the specified ad_account_id, filtered by the specified options.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Campaigns get
Read
Get a specific campaign given the campaign ID.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Campaigns list
Read
Get a list of the campaigns in the specified ad_account_id, filtered by the specified options.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Catalogs available filter values
Read
Get the available filter attributes and values associated with a given feed or catalog owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Catalogs create
Write
Create a new catalog owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Catalogs list
Read
Fetch catalogs owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Catalogs local inventory items batch operate
Write
Managing local inventory information in batches supporting CREATE, UPDATE, UPSERT, DELETE operations.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Catalogs local inventory items post
Read
Get local inventory items for a catalog owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Catalogs local stores create
Write
Create a local store for a catalog owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Catalogs local stores delete
Write
Delete multiple local stores for a catalog owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Catalogs local stores list
Read
Fetch local stores for a catalog owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Catalogs local stores update
Write
Update a local store for a catalog owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Catalogs product group pins list
Read
Get a list of product pins for a given Catalogs Product Group Id owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Catalogs product groups create
Write
Create product group to use in Catalogs owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Catalogs product groups delete
Write
Delete a product group owned by the "operation user_account" from being in use in Catalogs.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Catalogs product groups delete many
Write
Delete product groups owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Catalogs product groups get
Read
Get a single product group for a given Catalogs Product Group Id owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Catalogs product groups list
Read
Get a list of product groups for a given Catalogs Feed Id owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Catalogs product groups product counts get
Read
Get a product counts for a given Catalogs Product Group owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Catalogs product groups update
Write
Update product group owned by the "operation user_account" to use in Catalogs.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Catalogs supplemental items batch get
Read
Fetch the status and results of a supplemental items batch operation.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Conversion deletion request get
Read
This endpoint is currently in beta and not available to all apps.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Conversion deletion request list
Read
This endpoint is currently in beta and not available to all apps.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Conversion eqs list
Read
Get the Event Quality Score (EQS) of your conversion signals.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Conversion tags get
Read
Get information about an existing conversion tag.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Conversion tags list
Read
List conversion tags associated with an ad account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Country keywords metrics get
Read
See keyword metrics for a specified country, aggregated across all of Pinterest.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Customer list uploads get
Read
Get the metadata for a given upload by its ID.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Customer lists get
Read
Gets a specific customer list given the customer list ID.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Customer lists list
Read
Get a set of customer lists including id and name based on the filters provided.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Customer segment list
Read
Get a list of the customer segments in the specified ad_account_id.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Delivery metrics get
Read
Get the definitions for ads and organic metrics available across both synchronous and asynchronous report endpoints.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Feed processing results list
Read
Fetch a feed processing results owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Feeds create
Write
Create a new feed owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Feeds delete
Write
Delete a feed owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Feeds get
Read
Get a single feed owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Feeds ingest
Write
Ingest items for a given feed owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Feeds list
Read
Fetch feeds owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Feeds update
Write
Update a feed owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Follow user update
Write
This endpoint is currently in beta and not available to all apps.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Followers list
Read
Get a list of your followers.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Get ad groups by promotion ids list
Read
Get a list of ad groups that are associated with those promotion ids.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Get business employers
Read
Get all of the viewing user's business employers.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Get business members
Read
Get all members of the specified business.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Get business partners
Read
Get all partners of the specified business.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Get campaign delivery estimates
Read
Get delivery estimates for an ads campaign This endpoint is currently in beta and is not available to all apps [Learn more](/docs/new/about-beta-access/).
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Interest targeting options get
Read
Get details of a specific interest given interest ID.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Items batch get
Read
Get a single catalogs items batch owned by the "operating user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Items batch post
Write
This endpoint supports multiple operations on a set of one or more catalog items owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Items issues list
Read
List item validation issues for a given feed processing result owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Items post
Read
Get the items of the catalog owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Keywords get
Read
Get a list of keywords based on the filters provided.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Labels list
Read
[Closed beta](/docs/getting-started/using-beta-and-restricted-features/) See a list of labels for assets that your account owns, and filter the list by different criteria.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Lead form get
Read
This feature is currently in beta and not available to all apps, if you're interested in joining the beta, please reach out to your Pinterest account manager.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Lead forms list
Read
This feature is currently in beta and not available to all apps, if you're interested in joining the beta, please reach out to your Pinterest account manager.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Leads export create
Write
This feature is currently in beta and not available to all apps.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Leads export get
Read
This feature is currently in beta and not available to all apps.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Linked business accounts get
Read
Get a list of your linked business accounts.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Media get
Read
Get details for a registered media upload, including its current status.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Media list
Read
List media uploads filtered by given parameters.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Metrics ready state get
Read
Learn whether conversion or non-conversion metrics are finalized and ready to query.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Page visit conversion tags get
Read
Get all page visit conversion tag events for an ad account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Pins create
Write
Create a Pin on a board or board section owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Pins delete
Write
Delete a Pins owned by the "operation user_account" - or on a group board that has been shared with this account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Pins get
Read
Get a Pin owned by the "operation user_account" - or on a group board that has been shared with this account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Pins list
Read
Get a list of the Pins owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Pins save
Write
Save a Pin on a board or board section owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Pins update
Write
Update a pin owned by the "operating user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Product group promotions get
Read
Get a product group promotion by id.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Product group promotions list
Read
List existing product group promotions associated with an ad account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Product groups analytics
Read
Get analytics for the specified product groups in the specified ad_account_id, filtered by the specified options.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Product tags bulk add
Write
Add product tags to a pin.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Product tags bulk delete
Write
Delete product tags from a pin.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Product tags list
Read
Retrieve all product tags for a pin.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Products by product group filter list
Read
List products Pins owned by the "operation user_account" that meet the criteria specified in the Catalogs Product Group Filter given in the request.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Promotions get
Read
Get a promotion by its Pinterest-specific id.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Promotions list
Read
Gets all promotions associated with an ad account ID that can be applied to an ad group.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Reports create
Write
Async request to create a report of the catalog owned by the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reports get
Read
This returns a URL to a report given a token returned from [Build catalogs report](/docs/api/v5/#operation/reports/create).
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Schedules list
Read
Get schedules for a specific advertiser.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Search partner pins
Read
This endpoint is currently in beta and not available to all apps.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Search user boards get
Read
Search for boards for the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Search user pins list
Read
Search for pins for the "operation user_account".
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Shared audiences for business list
Read
Get a list of received audiences for the given business.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Targeting template list
Read
Get a list of the targeting templates in the specified ad_account_id.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Templates list
Read
Gets all Templates associated with an ad account ID.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Terms of service get
Read
Get the text of the terms of service and see whether the advertiser has accepted the terms of service.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Terms related list
Read
Get a list of terms logically related to each input term.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Trending keywords list
Read
Get the top trending search keywords among the Pinterest user audience.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Trends editorial articles list
Read
Get a list of published editorial articles.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Trends featured topics list
Read
Enables advertisers to pull top five trending topics by interest and market, at full parity with the Pinterest Trends UI.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Trends product categories details list
Read
Enables advertisers to retrieve demographic information, related pins, and trend lines for specified product categories.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Trends product categories trending list
Read
Get a list of growing Shopping Product Categories in ranked order allowing filtering by engagement type, vertical, age, and gender.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Unverify website delete
Write
Unverify a website verified by the signed-in user.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
User account analytics top pins
Read
Gets analytics data about a user's top pins (limited to the top 50).
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
User account analytics top video pins
Read
Gets analytics data about a user's top video pins (limited to the top 50).
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
User account followed interests
Read
Get a list of a user's following interests in one place.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
User account get
Read
Get account information for the "operation user_account" - By default, the "operation user_account" is the token user_account.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
User following get
Read
Get a list of who a certain user follows.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
User websites get
Read
Get user websites, claimed or not.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
Verify website update
Write
Verify a website as a signed-in user.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Website verification get
Read
Get verification code for user to install on the website to claim it.
Permissions and limits
Account permissions
A Pinterest access token with the scopes the call needs (see the Pinterest API reference)
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in Pinterest. A saved workflow is not a completed provider action.