Connectors
Social & Media
Visual discovery platform: pins, boards, and ad campaign management
Pinterest API referenceAPI checked August 16, 2026
- Signs in with
- API token
- Runs on
- Cloud or On-Prem Worker
- Operations
- 264
- Ready-made triggers
- 0
Connect Pinterest
- In Neblex open Connect › Connections and click New Connection.
- Search for Pinterest and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| Access tokenRequiredSecret | Pinterest OAuth or conversion access token. |
Use it in a flow
- Open a flow, open the node library and search for Pinterest.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
To start a flow from Pinterest without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if Pinterest can send webhooks, a Webhook trigger receives them at its own URL.
Operations
264 operations in 51 groups. Each one is a step you can add to a flow.
Ad Accounts14
Create a request for a brand, category, SKU reportcreateBrandCategorySkuReport | POST | Restricted This creates an asynchronous brand, category, SKU report based on the given request. |
Create a request for a Marketing Mix Modeling (MMM) reportcreateMmmReport | POST | This creates an asynchronous mmm report based on the given request. |
Create ad accountcreateAdAccount | POST | Create a new ad account. |
Create async request for an account analytics reportcreateAnalyticsReport | POST | This returns a token that you can use to download the report when it is ready. |
Create async request for an analytics report using a templaterunReportTemplate | POST | This takes a template ID and an optional custom timeframe and constructs an asynchronous report based on the template. |
Delete ads data for ad account in API SandboxdeleteSandboxData | DELETE | Delete an ad account and all the ads data associated with that account. |
Get ad accountgetAdAccount | GET | Get an ad account |
Get ad account analyticsgetAdAccountAnalytics | GET | Get analytics for the specified ad account id, filtered by the specified options. |
Get advertiser brand, category, SKU reportgetBrandCategorySkuReport | GET | Restricted Get a brand, category, SKU report for an ad account. |
Get advertiser Marketing Mix Modeling (MMM) report.getMmmReport | GET | Get an mmm report for an ad account. |
Get targeting analytics for an ad accountgetAccountTargetingAnalytics | GET | Get targeting analytics for an ad account. |
Get the account analytics report created by the async callgetAnalyticsReport | GET | This returns a URL to an analytics report given a token returned from the post request report creation call. |
List ad accountslistAdAccounts | GET | Get a list of the ad accounts that the "operation user account" has access to. |
List templateslistReportTemplates | GET | Gets all Templates associated with an ad account ID. |
Ad Groups13
Create ad groupscreateAdGroups | POST | Create multiple new ad groups. |
Get ad groupgetAdGroup | GET | Get a specific ad group given the ad group ID. |
Get ad group analyticsgetAdGroupAnalytics | GET | Get analytics for the specified ad groups in the specified ad account id, filtered by the specified options. |
Get audience sizinggetAudienceSizing | POST | Get potential audience size for an ad group with given targeting criteria. |
Get bid floorsgetBidFloors | POST | List bid floors for your campaign configuration. |
Get dynamic titles CSV download URLgetDynamicTitlesCsvUrl | GET | Get a presigned S3 download URL for the dynamic titles review CSV. |
Get dynamic titles statusgetDynamicTitlesStatus | GET | Get dynamic titles generation status for an ad group, including whether titles are ready for review and counts of generated and reviewed titles. |
Get dynamic titles upload URLgetDynamicTitlesUploadUrl | GET | Get a presigned S3 upload URL for the dynamic titles review CSV and a request id for submission. |
Get targeting analytics for ad groupsgetAdGroupTargetingAnalytics | GET | Get targeting analytics for one or more ad groups. |
List ad groupslistAdGroups | GET | List ad groups based on provided campaign IDs or ad group IDs.(campaign ids or ad group ids). |
List of ad groups using promotions IDs.listPromotionAppliedEntities | GET | Get a list of ad groups that are associated with those promotion ids |
Process dynamic titles CSVprocessDynamicTitlesCsv | POST | Validate and process the uploaded dynamic titles review CSV. |
Update ad groupsupdateAdGroups | PATCH | Update multiple existing ad groups. |
Ads10
Create ad preview records for one or more ad groupscreateCampaignAdPreviews | POST | Create ad preview records for one or more ad groups that can be shared. |
Create ad preview with pin or imagecreateAdPreview | POST | Create an ad preview given an ad account ID and either an existing organic pin ID or the URL for an image to be used to create the Pin and the ad. |
Create adscreateAds | POST | Create multiple new ads. |
Delete ad preview records for one or more ad groupsdeleteCampaignAdPreviews | DELETE | Delete ad preview records for one or more ad groups. |
Fetch ad preview records for one or more ad groupslistCampaignAdPreviews | GET | Fetch ad preview records for one or more ad groups. |
Get adgetAd | GET | Get a specific ad given the ad ID. |
Get ad analyticsgetAdAnalytics | GET | Get analytics for the specified ads in the specified ad account id, filtered by the specified options. |
Get targeting analytics for adsgetAdTargetingAnalytics | GET | Get targeting analytics for one or more ads. |
List adslistAds | GET | List ads that meet the filters provided: - Listed campaign ids or ad group ids or ad ids - Listed entity statuses |
Update adsupdateAds | PATCH | Update multiple existing ads |
Advanced Auction2
Get item bid options (POST)getItemBidOptions | POST | Get the bid options for a batch of retail catalog items. |
Operate on item level bid optionssubmitItemBidOptions | POST | This endpoint supports multiple operations on a set of one or more bid options (bid price and bid adjustments for targeting categories) for retail catalog items. |
Audience Insights2
Get audience insightsgetAudienceInsights | GET | Get Audience Insights for an ad account. |
Get audience insights scope and typegetAudienceInsightsScope | GET | 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. |
Audience Sharing7
List accounts with access to an audience owned by a businesslistBusinessSharedAudienceAccounts | GET | List all ad accounts and/or businesses that have access to a specific audience. |
List accounts with access to an audience owned by an ad accountlistSharedAudienceAccounts | GET | List all ad accounts and/or businesses that have access to a specific audience. |
List received audiences for a businesslistBusinessAudiences | GET | Get a list of received audiences for the given business. |
Update audience sharing between ad accountsshareAudienceWithAccounts | PATCH | From an ad account, share a specific audience with another ad account, or revoke access to a previously shared audience. |
Update audience sharing between businessesshareBusinessAudienceWithBusinesses | PATCH | From a business, share a specific audience with another business account, or revoke access to a previously shared audience. |
Update audience sharing from a business to ad accountsshareBusinessAudienceWithAccounts | PATCH | From a business, share a specific audience with other ad account(s), or revoke access to a previously shared audience. |
Update audience sharing from an ad account to businessesshareAudienceWithBusinesses | PATCH | From an ad account, share a specific audience with a business account, or revoke access to a previously shared audience. |
Audiences4
Create audiencecreateAudience | POST | Create a new audience for the ad account. |
Get audiencegetAudience | GET | Get a specific audience given the audience ID. |
List audienceslistAudiences | GET | Get list of audiences for the ad account. |
Update audienceupdateAudience | PATCH | Update an existing audience for the ad account. |
Billing11
Create insertion order through SSIO.createSsioInsertionOrder | POST | Create insertion order through SSIO for ad account id. |
Edit insertion order through SSIO.updateSsioInsertionOrder | PATCH | Edit insertion order through SSIO for ad account id. |
Get ads credit discountsgetAdsCreditDiscounts | GET | Returns the list of discounts applied to the account. |
Get billing invoiceslistBillingInvoices | GET | Get billing invoices in the advertiser account. |
Get billing profileslistBillingProfiles | GET | Get billing profiles in the advertiser account. |
Get download url for a billing invoicegetBillingInvoiceDownload | GET | Get download url for a billing invoice. |
Get insertion order status by ad account id.getSsioOrderStatuses | GET | Get insertion order status for ad account id. |
Get insertion order status by pin order id.getSsioOrderStatus | GET | Get insertion order status for pin order id. |
Get Salesforce account details including bill-to information.getSsioAccounts | GET | Get Salesforce account details including bill-to information to be used in insertion orders process for ad account id. |
Get Salesforce order lines by ad account id.getSsioOrderLines | GET | Get Salesforce order lines for account id ad account id. |
Redeem ad creditsredeemAdsCredit | POST | Redeem ads credit on behalf of the ad account id and apply it towards billing. |
Boards11
Create boardcreateBoard | POST | Create a board owned by the "operation user account". |
Create board sectioncreateBoardSection | POST | 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. |
Delete boarddeleteBoard | DELETE | Delete a board owned by the "operation user account". |
Delete board sectiondeleteBoardSection | DELETE | 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. |
Get boardgetBoard | GET | Get a board owned by the operation user account - or a group board that has been shared with this account. |
List board sectionslistBoardSections | GET | 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. |
List boardslistBoards | GET | 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 owner of... |
List Pins on boardlistBoardPins | GET | 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. |
List Pins on board sectionlistBoardSectionPins | GET | 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. |
Update boardupdateBoard | PATCH | Update a board owned by the "operating user account". |
Update board sectionupdateBoardSection | PATCH | 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. |
Bulk3
Create/update ad entities in bulkbulkUpsert | POST | Either create or update any combination of campaigns, ad groups, product groups, ads, keywords, schedules, or labels. |
Download advertiser entities in bulkgetBulkRequest | GET | 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, ads,... |
Get advertiser entities in bulkbulkDownload | POST | Create an asynchronous report that may include information on campaigns, ad groups, product groups, ads, keywords, schedules,and/or labels; can filter by campaigns. |
Business Access Assets12
Assign/Update member asset permissionsupdateMemberAssetAccess | PATCH | Grant multiple members access to assets and/or update multiple member's exisiting permissions to an asset. |
Assign/Update partner asset permissionsupdatePartnerAssetAccess | PATCH | Grant multiple partners access to assets and/or update multiple partner's exisiting permissions to an asset. |
Create a new asset group.createAssetGroup | POST | Create a new asset group with the specified parameters. |
Delete asset groups.deleteAssetGroups | DELETE | Delete a batch of asset groups. |
Delete member access to assetdeleteMemberAssetAccess | DELETE | Terminate multiple members' access to an asset. |
Delete partner access to assetdeletePartnerAssetAccess | DELETE | Terminate multiple partners' access to an asset. |
Get assets assigned to a membergetMemberAssets | GET | Get assets on which you assigned asset permissions to the given member. |
Get assets assigned to a partner or assets assigned by a partnergetPartnerAssets | GET | 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. |
Get members with access to assetgetAssetMembers | GET | Get all the members the requesting business has granted access to on the given asset. |
Get partners with access to assetgetAssetPartners | GET | Get all the partners the requesting business has granted access to on the given asset. |
List business assetslistBusinessAssets | GET | Get all the assets the requesting business has access to. |
Update asset groups.updateAssetGroups | PATCH | Update a batch of asset groups with the specified parameters. |
Business Access Invite6
Accept or decline an invite/requestrespondToInvites | PATCH | Accept or decline invites or requests. |
Cancel invites/requestscancelBusinessInvites | DELETE | Cancel membership/partnership invites and/or requests. |
Create a request to access an existing partner's assets.requestPartnerAssetAccess | POST | Create a request to access an existing partner's assets with the specified permissions. |
Create invites or requestscreateBusinessInvites | POST | Create batch invites or requests. |
Get invites/requestslistBusinessInvites | GET | Get the membership/partnership invites and/or requests for the authorized user. |
Update invite/request with an asset permissionupdateInviteAssetAccess | POST | Assign asset permissions information to an existing invite/request. |
Business Access Relationships9
Create a Brand AccountcreateBrandAccount | POST | Create a Brand Account that will be a child business of a business hierarchy. |
Get business membersgetBusinessMembers | GET | Get all members of the specified business. |
Get business partnersgetBusinessPartners | GET | Get all partners of the specified business. |
List business employers for userlistBusinessEmployers | GET | Get all of the viewing user's business employers. |
Terminate business membershipsterminateBusinessMembers | DELETE | Terminate memberships between the specified members and your business. |
Terminate business partnershipsterminateBusinessPartners | DELETE | Terminate partnerships between the specified partners and your business. |
Update a Brand AccountupdateBrandAccount | PATCH | Update an existing Brand Account |
Update a system user information.updateSystemUser | PATCH | Update a system user information such as name. |
Update member's business roleupdateBusinessMembers | PATCH | Update a member's business role within the business. |
Campaigns8
Create campaignscreateCampaigns | POST | Create multiple new campaigns. |
Get campaigngetCampaign | GET | Get a specific campaign given the campaign ID. |
Get campaign analyticsgetCampaignAnalytics | GET | Get analytics for the specified campaigns in the specified ad account id, filtered by the specified options. |
Get campaign delivery estimatesgetCampaignDeliveryEstimates | POST | Get delivery estimates for an ads campaign |
Get pins analyticsgetPinsAnalytics | GET | Get analytics for the pins given a campaign and pins in the specified ad account id, filtered by the specified options. |
Get targeting analytics for campaignsgetCampaignTargetingAnalytics | GET | Get targeting analytics for one or more campaigns. |
List campaignslistCampaigns | GET | Get a list of the campaigns in the specified ad account id, filtered by the specified options. |
Update campaignsupdateCampaigns | PATCH | Update multiple ad campaigns based on campaign ids. |
Catalog Feeds8
Create feedcreateFeed | POST | Create a new feed owned by the "operation user account". |
Delete feeddeleteFeed | DELETE | Delete a feed owned by the "operation user account". |
Get feedgetFeed | GET | Get a single feed owned by the "operation user account". |
Ingest feed itemsingestFeed | POST | Ingest items for a given feed owned by the "operation user account". |
List feed processing resultslistFeedProcessingResults | GET | Fetch a feed processing results owned by the "operation user account". |
List feedslistFeeds | GET | Fetch feeds owned by the "operation user account". |
List item issueslistItemIssues | GET | List item validation issues for a given feed processing result owned by the "operation user account". |
Update feedupdateFeed | PATCH | Update a feed owned by the "operation user account". |
Catalog Items3
Get catalogs items (POST)getCatalogItems | POST | Get the items of the catalog owned by the "operation user account". |
Get item batch statusgetItemBatchStatus | GET | Get a single catalogs items batch owned by the "operating user account". |
Operate on item batchoperateItemBatch | POST | This endpoint supports multiple operations on a set of one or more catalog items owned by the "operation user account". |
Catalog Product Groups10
Create product groupcreateProductGroup | POST | Create product group to use in Catalogs owned by the "operation user account". |
Create product groupscreateProductGroups | POST | Create product group to use in Catalogs owned by the "operation user account". |
Delete product groupdeleteProductGroup | DELETE | Delete a product group owned by the "operation user account" from being in use in Catalogs. |
Delete product groupsdeleteProductGroups | DELETE | Delete product groups owned by the "operation user account". |
Get product countsgetProductCounts | GET | Get a product counts for a given Catalogs Product Group owned by the "operation user account". |
Get product groupgetProductGroup | GET | Get a single product group for a given Catalogs Product Group Id owned by the "operation user account". |
List product groupslistProductGroups | GET | Get a list of product groups for a given Catalogs Feed Id owned by the "operation user account". |
List products by filterlistProductsByFilters | POST | List products Pins owned by the "operation user account" that meet the criteria specified in the Catalogs Product Group Filter given in the request. |
List products by product grouplistProductsByGroup | GET | Get a list of product pins for a given Catalogs Product Group Id owned by the "operation user account". |
Update single product groupupdateProductGroup | PATCH | Update product group owned by the "operation user account" to use in Catalogs. |
Catalog Reports3
Build catalogs reportbuildCatalogsReport | POST | Async request to create a report of the catalog owned by the "operation user account". |
Get catalogs reportgetCatalogsReport | GET | This returns a URL to a report given a token returned from Build catalogs report. |
List report statslistCatalogsReportStats | GET | List aggregated numbers of issues for a catalog owned by the "operation user account". |
Catalog Supplemental7
Create local storescreateLocalStores | POST | Create a local store for a catalog owned by the "operation user account". |
Delete local storesdeleteLocalStores | DELETE | Delete multiple local stores for a catalog owned by the "operation user account". |
Get local inventory items (POST)queryLocalInventoryItems | POST | Get local inventory items for a catalog owned by the "operation user account". |
Get supplemental items batch statusgetSupplementalBatchStatus | GET | Fetch the status and results of a supplemental items batch operation. |
List local storeslistLocalStores | GET | Fetch local stores for a catalog owned by the "operation user account". |
Operate on local inventory item batchoperateLocalInventoryBatch | POST | Managing local inventory information in batches supporting CREATE, UPDATE, UPSERT, DELETE operations. |
Update local storesupdateLocalStores | PATCH | Update a local store for a catalog owned by the "operation user account". |
Catalogs3
Create catalogcreateCatalog | POST | Create a new catalog owned by the "operation user account". |
List available filter valueslistCatalogFilterValues | GET | Get the available filter attributes and values associated with a given feed or catalog owned by the "operation user account". |
List catalogslistCatalogs | GET | Fetch catalogs owned by the "operation user account". |
Conversion Deletion Requests4
Create a conversion deletion requestcreateConversionDeletionRequest | POST | This endpoint is currently in beta and not available to all apps. |
Delete a conversion deletion requestcancelConversionDeletionRequest | DELETE | This endpoint is currently in beta and not available to all apps. |
Get a single conversion deletion requestgetConversionDeletionRequest | GET | This endpoint is currently in beta and not available to all apps. |
List conversion deletion requestslistConversionDeletionRequests | GET | This endpoint is currently in beta and not available to all apps. |
Conversion Eqs1
Get event quality score (EQS)getEventQualityScore | GET | Get the Event Quality Score (EQS) of your conversion signals. |
Conversion Events1
Send conversionssendConversionEvents | POST | The Pinterest API offers advertisers a way to send Pinterest their conversion information (including web conversions, in-app conversions, or even offline conversions) based on their ad... |
Conversion Tags5
Create conversion tagcreateConversionTag | POST | Create a conversion tag, also known as Pinterest tag, with the option to enable enhanced match. |
Get conversion taggetConversionTag | GET | Get information about an existing conversion tag. |
Get Ocpm eligible conversion tagsgetOcpmEligibleConversionTags | GET | Get Ocpm eligible conversion tag events for an ad account. |
Get page visit conversion tagsgetPageVisitConversionTags | GET | Get all page visit conversion tag events for an ad account. |
List conversion tagslistConversionTags | GET | List conversion tags associated with an ad account. |
Conversions4
Create advertiser defined eventscreateAdvertiserDefinedEvents | POST | Map advertiser defined events to standard events for the given ad account. |
Delete advertiser defined eventsdeleteAdvertiserDefinedEvents | DELETE | Untrack advertiser defined events for the given ad account. |
Get advertiser defined eventslistAdvertiserDefinedEvents | GET | Get advertiser defined events for the given ad account. |
Update advertiser defined eventsupdateAdvertiserDefinedEvents | PATCH | Update advertiser defined event names or mappings for the given ad account. |
Customer List Uploads3
Create customer list uploadcreateCustomerListUpload | POST | Create a customer list upload request for multipart S3 upload. |
Get customer list uploadgetCustomerListUpload | GET | Get the metadata for a given upload by its ID. |
Run customer list uploadrunCustomerListUpload | POST | Begin processing a customer list upload. |
Customer Lists4
Create customer listscreateCustomerList | POST | Create a customer list from your records (hashed or plain-text email addresses, or hashed MAIDs or IDFAs). |
Get customer listgetCustomerList | GET | Gets a specific customer list given the customer list ID. |
Get customer listslistCustomerLists | GET | Get a set of customer lists including id and name based on the filters provided. |
Update customer listupdateCustomerList | PATCH | Append or remove records to/from an existing customer list. |
Customer Segment3
Create customer segmentscreateCustomerSegment | POST | Customer segments allow advertisers to define existing customers for Pinterest Performance+ campaigns. |
List customer segmentslistCustomerSegments | GET | Get a list of the customer segments in the specified ad account id. |
Update customer segmentsupdateCustomerSegment | PATCH | Update the customer segment given advertiser ID and customer segment ID |
Integrations7
Create commerce integrationcreateCommerceIntegration | POST | Create commerce integration metadata to link an external business ID with a Pinterest merchant & ad account. |
Delete commerce integrationdeleteCommerceIntegration | DELETE | Delete commerce integration metadata for the given external business ID. |
Get commerce integrationgetCommerceIntegration | GET | Get commerce integration metadata associated with the given external business ID. |
Get integration metadatagetIntegration | GET | Get integration metadata by ID. |
Get integration metadata listlistIntegrations | GET | Get integration metadata list. |
Receives batched logs from integration applications.sendIntegrationLogs | POST | This endpoint receives batched logs from integration applications on partner platforms. |
Update commerce integrationupdateCommerceIntegration | PATCH | Update commerce integration metadata for the given external business ID. |
Keywords5
Create keywordscreateKeywords | POST | Create keywords for the following entity types (advertiser, campaign, ad group, or ad). |
Get country's keyword metricsgetKeywordMetrics | GET | See keyword metrics for a specified country, aggregated across all of Pinterest. |
Get keywordslistKeywords | GET | Get a list of keywords based on the filters provided. |
List trending keywordslistTrendingKeywords | GET | Get the top trending search keywords among the Pinterest user audience. |
Update keywordsupdateKeywords | PATCH | Update one or more keywords' bid and archived fields. |
Labels5
Apply label to entityapplyLabel | POST | Closed beta |
Create labelscreateLabels | POST | Closed beta |
List labelslistLabels | GET | Closed beta |
Remove label from entitiesremoveLabel | POST | Closed beta |
Update labelsupdateLabels | PATCH | Closed beta |
Lead Ads4
Create lead ads subscriptioncreateLeadAdsSubscription | POST | Create a lead ads webhook subscription. |
Delete lead ads subscriptiondeleteLeadAdsSubscription | DELETE | Delete an existing lead ads webhook subscription by ID. |
Get lead ads subscription by IDgetLeadAdsSubscription | GET | Get an existing lead ads webhook subscription by ID. |
Get lead ads subscriptionslistLeadAdsSubscriptions | GET | Get the advertiser's list of lead ads subscriptions. |
Lead Forms5
Create lead form test datacreateLeadFormTestData | POST | Create lead form test data based on the list of answers provided as part of the body. |
Create lead formscreateLeadForms | POST | 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. |
Get lead form by idgetLeadForm | GET | 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. |
List lead formslistLeadForms | GET | 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. |
Update lead formsupdateLeadForms | PATCH | 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. |
Leads Export2
Create a request to export leads collected from a lead adcreateLeadsExport | POST | This feature is currently in beta and not available to all apps. |
Get the lead export from the lead export create callgetLeadsExport | GET | This feature is currently in beta and not available to all apps. |
Media3
Get media upload detailsgetMediaUpload | GET | Get details for a registered media upload, including its current status. |
List media uploadslistMediaUploads | GET | List media uploads filtered by given parameters. |
Register media uploadregisterMediaUpload | POST | Register your intent to upload media. |
Msot Events1
Send Measurement Source Of Truth (MSOT) attributed conversion eventssendMsotEvents | POST | This feature is currently in beta and not available to all apps. |
Notification1
Receive notifications from external partners.receivePartnerNotifications | POST | Used by third-party partners to send notifications to Pinterest. |
Oauth1
Generate OAuth access token for conversion APIgenerateConversionToken | POST | Generate a new and long-lived OAuth access token dedicated for sending conversions using a valid access token. |
Order Lines2
Get order linegetOrderLine | GET | Get a specific existing order line associated with an ad account. |
Get order lines.listOrderLines | GET | List existing order lines associated with an ad account. |
Pins8
Create PincreatePin | POST | Create a Pin on a board or board section owned by the "operation user account". |
Delete PindeletePin | DELETE | Delete a Pins owned by the "operation user account" - or on a group board that has been shared with this account. |
Get multiple Pin analyticsgetMultiplePinAnalytics | GET | This endpoint is currently in beta and not available to all apps. |
Get PingetPin | GET | Get a Pin owned by the "operation user account" - or on a group board that has been shared with this account. |
Get Pin analyticsgetPinAnalytics | GET | Get analytics for a Pin owned by the "operation user account" - or on a group board that has been shared with this account. |
List PinslistPins | GET | Get a list of the Pins owned by the "operation user account". |
Save PinsavePin | POST | Save a Pin on a board or board section owned by the "operation user account". |
Update PinupdatePin | PATCH | Update a pin owned by the "operating user account". |
Product Group Promotions5
Create product group promotionscreateProductGroupPromotion | POST | Add one or more product groups from your catalog to an existing ad group. |
Get a product group promotion by idgetProductGroupPromotion | GET | Get a product group promotion by id |
Get product group analyticsgetProductGroupAnalytics | GET | Get analytics for the specified product groups in the specified ad account id, filtered by the specified options. |
Get product group promotionslistProductGroupPromotions | GET | List existing product group promotions associated with an ad account. |
Update product group promotionsupdateProductGroupPromotion | PATCH | Update multiple existing Product Group Promotions (by product group id) |
Product Tags3
Add product tags to pinaddProductTags | POST | Add product tags to a pin. |
Delete product tags from pindeleteProductTags | POST | Delete product tags from a pin. |
Get product tags for pingetProductTags | GET | Retrieve all product tags for a pin. |
Promotions5
Create promotionscreatePromotions | POST | Create multiple new promotions. |
Delete promotion by iddeletePromotion | DELETE | Delete a promotion within Pinterest. |
Get promotion by idgetPromotion | GET | Get a promotion by its Pinterest-specific id. |
Get promotionslistPromotions | GET | Gets all promotions associated with an ad account ID that can be applied to an ad group. |
Update promotionsupdatePromotions | PATCH | Update multiple promotions. |
Resources6
Get ad accounts countriesgetAdAccountCountries | GET | Get Ad Accounts countries |
Get available metrics' definitionsgetDeliveryMetricsDefinitions | GET | Get the definitions for ads and organic metrics available across both synchronous and asynchronous report endpoints. |
Get interest detailsgetInterestDetails | GET | Get details of a specific interest given interest ID. |
Get lead form questionsgetLeadFormQuestions | GET | Get a list of all lead form question type names. |
Get metrics ready stategetMetricsReadyState | GET | Learn whether conversion or non-conversion metrics are finalized and ready to query. |
Get targeting optionsgetTargetingOptions | GET | You can use targeting values in ads placement to define your intended audience. |
Schedules3
Create schedulescreateSchedules | POST | Batch create schedules |
Get ScheduleslistSchedules | GET | Get schedules for a specific advertiser |
Update schedulesupdateSchedules | PATCH | Update one or more schedules |
Search3
Search pins by a given search termsearchPartnerPins | GET | This endpoint is currently in beta and not available to all apps. |
Search user's boardssearchBoards | GET | Search for boards for the "operation user account". |
Search user's PinssearchPins | GET | Search for pins for the "operation user account". |
Targeting Template3
Create targeting templatescreateTargetingTemplate | POST | Targeting templates allow advertisers to save a set of targeting details including audience lists, keywords & interest, demographics, and placements to use more than once during the... |
List targeting templateslistTargetingTemplates | GET | Get a list of the targeting templates in the specified ad account id |
Update targeting templatesupdateTargetingTemplate | PATCH | Update the targeting template given advertiser ID and targeting template ID |
Terms2
List related termslistRelatedTerms | GET | Get a list of terms logically related to each input term. |
List suggested termslistSuggestedTerms | GET | Get popular search terms that begin with your input term. |
Terms Of Service1
Get terms of servicegetTermsOfService | GET | Get the text of the terms of service and see whether the advertiser has accepted the terms of service. |
Trends4
Get a list of growing Shopping Product CategoriesgetTrendingProductCategories | GET | Get a list of growing Shopping Product Categories in ranked order allowing filtering by engagement type, vertical, age, and gender. |
Get featured topicsgetFeaturedTopics | GET | Enables advertisers to pull top five trending topics by interest and market, at full parity with the Pinterest Trends UI. |
Get product category detailsgetProductCategoryDetails | GET | Enables advertisers to retrieve demographic information, related pins, and trend lines for specified product categories |
Returns editorial articles for a given regiongetEditorialArticles | GET | Get a list of published editorial articles. |
User Account14
Follow userfollowUser | POST | This endpoint is currently in beta and not available to all apps. |
Get user accountgetUserAccount | GET | Get account information for the "operation user account" - By default, the "operation user account" is the token user account. |
Get user account analyticsgetUserAnalytics | GET | Get analytics for the "operation user account" - By default, the "operation user account" is the token user account. |
Get user account top pins analyticsgetTopPinsAnalytics | GET | Gets analytics data about a user's top pins (limited to the top 50). |
Get user account top video pins analyticsgetTopVideoPinsAnalytics | GET | Gets analytics data about a user's top video pins (limited to the top 50). |
Get user verification code for website claiminggetWebsiteVerificationCode | GET | Get verification code for user to install on the website to claim it. |
Get user websitesgetUserWebsites | GET | Get user websites, claimed or not |
List followerslistFollowers | GET | Get a list of your followers. |
List followinglistFollowing | GET | Get a list of who a certain user follows. |
List following boardslistFollowingBoards | GET | Get a list of the boards a user follows. |
List following interestslistFollowingInterests | GET | Get a list of a user's following interests in one place. |
List linked businesseslistLinkedBusinesses | GET | Get a list of your linked business accounts. |
Unverify websiteunverifyWebsite | DELETE | Unverify a website verified by the signed-in user. |
Verify websiteverifyWebsite | POST | Verify a website as a signed-in user. |