Pinterest API integration and automation platform
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.pinterest.com/v5 | link | — | — | — |
Actions (85)
Ads · 40
- Create SSIO insertion orderPOST /ad_accounts/{ad_account_id}/ssio/insertion_orders
Create an insertion order via SSIO for the advertiser.
documented - Create adPOST /ad_accounts/{ad_account_id}/ads
Create an ad in an ad account.
documented - Create ad accountPOST /ad_accounts
Create a new advertiser ad account (requires appropriate permissions).
documented - Create ad groupPOST /ad_accounts/{ad_account_id}/ad_groups
Create ad group(s) under an ad account.
documented - Create bulk downloadPOST /ad_accounts/{ad_account_id}/bulk/download
Create a bulk download job for advertiser entities.
documented - Create bulk upsertPOST /ad_accounts/{ad_account_id}/bulk/upsert
Create or update advertiser entities in bulk (campaigns, ad groups, ads, etc.).
documented - Create bulk upsert (duplicate)POST /ad_accounts/{ad_account_id}/bulk/upsert
Create/update advertiser entities in bulk (duplicate path example).
documented - Create campaignPOST /ad_accounts/{ad_account_id}/campaigns
Create a new campaign.
documented - Create conversion tagPOST /ad_accounts/{ad_account_id}/conversion_tags
Create a conversion tag for measurement (Pinterest Tag / CAPI).
documented - Create lead formPOST /ad_accounts/{ad_account_id}/lead_forms
Create a lead form for an ad account.
documented - Create lead form test dataPOST /ad_accounts/{ad_account_id}/lead_forms/{lead_form_id}/test
Create test data for a lead form.
documented - Create leads exportPOST /ad_accounts/{ad_account_id}/leads_export
Request an export of leads collected from lead ads.
documented - Get SSIO insertion order statusGET /ad_accounts/{ad_account_id}/ssio/insertion_orders/{pin_order_id}/status
Get the status of an SSIO insertion order by pin_order_id.
documented - Get adGET /ad_accounts/{ad_account_id}/ads/{ad_id}
Get a specific ad.
documented - Get ad accountGET /ad_accounts/{ad_account_id}
Get a specific advertiser ad account.
documented - Get ad analyticsGET /ad_accounts/{ad_account_id}/ads/analytics
Analytics for ads.
documented - Get ad groupGET /ad_accounts/{ad_account_id}/ad_groups/{ad_group_id}
Get a specific ad group.
documented - Get ad group analyticsGET /ad_accounts/{ad_account_id}/ad_groups/analytics
Analytics for ad groups.
documented - Get ad group audience sizingPOST /ad_accounts/{ad_account_id}/ad_groups/audience_sizing
Estimate audience size for ad groups.
documented - Get ad group targeting analyticsGET /ad_accounts/{ad_account_id}/ad_groups/targeting_analytics
Targeting analytics for ad groups.
documented - Get campaignGET /ad_accounts/{ad_account_id}/campaigns/{campaign_id}
Get a specific campaign.
documented - Get campaign analyticsGET /ad_accounts/{ad_account_id}/campaigns/{campaign_id}/analytics
Analytics for campaigns.
documented - Get conversion tagGET /ad_accounts/{ad_account_id}/conversion_tags/{conversion_tag_id}
Get a single conversion tag.
documented - Get lead ads subscription by IDGET /ad_accounts/{ad_account_id}/leads/subscriptions/{subscription_id}
Retrieve a lead ad webhook subscription by ID.
documented - Get lead formGET /ad_accounts/{ad_account_id}/lead_forms/{lead_form_id}
Get a specific lead form.
documented - Get leads exportGET /ad_accounts/{ad_account_id}/leads_export/{leads_export_id}
Retrieve the lead export payload/link.
documented - Get targeting analyticsGET /ad_accounts/{ad_account_id}/targeting_analytics
Get targeting analytics for the ad account.
documented - List MMM reportsGET /ad_accounts/{ad_account_id}/mmm_reports
Get Marketing Mix Modeling reports for an ad account.
documented - List SSIO accountsGET /ad_accounts/{ad_account_id}/ssio/accounts
Sales/Insertion Order accounts details for SSIO.
documented - List ad accountsGET /ad_accounts
List the advertiser ad accounts accessible to the token/user.
documented - List ad groupsGET /ad_accounts/{ad_account_id}/ad_groups
List ad groups under an ad account.
documented - List adsGET /ad_accounts/{ad_account_id}/ads
List ads in an ad account.
documented - List billing profilesGET /ad_accounts/{ad_account_id}/billing_profiles
List billing profiles for the ad account.
documented - List campaignsGET /ad_accounts/{ad_account_id}/campaigns
List campaigns under an ad account.
documented - List conversion tagsGET /ad_accounts/{ad_account_id}/conversion_tags
List conversion tags for an ad account.
documented - List lead formsGET /ad_accounts/{ad_account_id}/lead_forms
List lead forms for an ad account.
documented - List targeting templatesGET /ad_accounts/{ad_account_id}/targeting_templates
List targeting templates for the ad account.
documented - Send conversionsGET /ad_accounts/{ad_account_id}/events
Submit conversion events to Pinterest (Conversions API) for the specified ad account.
documented - Update adPATCH /ad_accounts/{ad_account_id}/ads/{ad_id}
Update an ad.
documented - Update ad groupPATCH /ad_accounts/{ad_account_id}/ad_groups/{ad_group_id}
Update an ad group.
documented
Catalogs · 20
- Create catalogs product groupPOST /catalogs/product_groups
Create a catalogs product group to use in Catalogs.
documented - Create multiple catalogs product groupsPOST /catalogs/product_groups/multi
Batch-create multiple catalogs product groups.
documented - Delete catalog feedDELETE /catalogs/feeds/{feed_id}
Delete a catalog feed.
documented - Delete catalogs product groupDELETE /catalogs/product_groups/{product_group_id}
Delete a catalogs product group.
documented - Delete multiple catalogs product groupsDELETE /catalogs/product_groups/multiple
Delete multiple catalogs product groups in a single operation.
documented - Get available filter valuesGET /catalogs/available_filter_values
Return available filter attributes/values for catalogs.
documented - Get catalog feedGET /catalogs/feeds/{feed_id}
Retrieve a catalog feed.
documented - Get catalog itemsPOST /catalogs/items
Request catalog items (POST) for a catalog owned by the operation user_account.
documented - Get catalog product countsGET /catalogs/product_groups/{product_group_id}/product_counts
Get counts for products in a catalogs product group.
documented - Get catalogs items batchGET /catalogs/items/batch/{batch_id}
Check status of a catalogs items batch.
documented - Get catalogs items batchPOST /catalogs/items/batch
Fetch items in batch for catalogs.
documented - Get catalogs product groupGET /catalogs/product_groups/{product_group_id}
Get a single catalogs product group.
documented - Get product countsGET /catalogs/product_groups/{product_group_id}/product_counts
Get product counts for a catalogs product group.
documented - Ingest catalog feedPOST /catalogs/feeds/{feed_id}/ingest
Ingest items for a catalog feed.
documented - List catalogs processing resultsGET /catalogs/processing_results
List catalog processing results.
documented - List catalogs product groupsGET /catalogs/product_groups
List catalogs product groups for a catalog feed.
documented - List feed processing resultsGET /catalogs/feeds/{feed_id}/processing_results
List processing results for a catalog feed.
documented - List item issuesGET /catalogs/processing_results/{processing_result_id}/item_issues
List item validation issues for a feed processing result.
documented - List products in product groupGET /catalogs/product_groups/{product_group_id}/products
List products for a catalogs product group.
documented - Update catalogs product groupPATCH /catalogs/product_groups/{product_group_id}
Update a catalogs product group.
documented
Boards · 11
- Create boardPOST /boards
Create a board owned by the operation user_account.
documented - Create board sectionPOST /boards/{board_id}/sections
Create a new section on a board.
documented - Delete boardDELETE /boards/{board_id}
Delete a board owned by the operation user_account.
documented - Delete board sectionDELETE /boards/{board_id}/sections/{section_id}
Delete a board section.
documented - Get boardGET /boards/{board_id}
Retrieve a board owned by the operation user_account or a group board shared with the account.
documented - List board sectionsGET /boards/{board_id}/sections
Get all sections on a board.
documented - List boardsGET /boards
List boards owned by the operation user_account (and group boards where the account is a collaborator).
documented - List pins on boardGET /boards/{board_id}/pins
List Pins on a specific board.
documented - List pins on board sectionGET /boards/{board_id}/sections/{section_id}/pins
List Pins in a board section.
documented - Update boardPATCH /boards/{board_id}
Update a board owned by the operation user_account.
documented - Update board sectionPATCH /boards/{board_id}/sections/{section_id}
Update a board section on a board.
documented
Pins · 9
- Create pinPOST /pins
Create a new Pin on a board or board section owned by the operation user_account.
documented - Delete pinDELETE /pins/{pin_id}
Delete a Pin owned by the operation user_account.
documented - Get multiple pins analyticsGET /pins/analytics
Fetch analytics for multiple Pins in a single request (beta/limited availability for some apps).
documented - Get pinGET /pins/{pin_id}
Retrieve a Pin owned by the operation user_account or a shared group board.
documented - Get pin analyticsGET /pins/{pin_id}/analytics
Retrieve analytics for a specific Pin.
documented - List pinsGET /pins
List Pins owned by the operation user_account (default) or by an ad account owner if a valid ad_account_id is supplied.
documented - Save pinPOST /pins/{pin_id}/save
Save a Pin to a board/board section owned by the operation user_account.
documented - Search pinsGET /search/pins
Search Pins by keywords and other criteria.
documented - Update pinPATCH /pins/{pin_id}
Update a Pin owned by the operation user_account.
documented
OAuth · 3
- Generate Conversion API OAuth tokenPOST /oauth/conversion_token
Generate a dedicated OAuth access token for Conversions API usage.
documented - Generate OAuth access tokenPOST /oauth/token
Obtain an OAuth access token using an authorization code (or refresh token flow).
documented - Revoke OAuth tokenPOST /oauth/token/revoke
Revoke an OAuth access token.
documented