Pinterest

✅ Authorization

Tools	Status
Pre-built authorization (OAuth)	✅
Credentials auto-refresh	✅
Auth parameters validation	✅
Pre-built authorization UI	✅
Custom authorization UI	✅
Expired credentials detection	✅

✅ Read & write data

Tools	Status
Pre-built integrations	✅
API unification	✅
2-way sync	✅
Webhooks from Tenklo on data modifications	✅
Real-time webhooks from 3rd-party API	🚫 (time to contribute: <48h)
Proxy requests	✅

✅ Observability & data quality

Tools	Status
HTTP request logging	✅
End-to-end type safety	✅
Data runtime validation	✅
OpenTelemetry export	✅
Slack alerts on errors	✅
Integration status API	✅

✅ Customization

Tools	Status
Create or customize use-cases	✅
Pre-configured pagination	🚫 (time to contribute: <48h)
Pre-configured rate-limit handling	🚫 (time to contribute: <48h)
Per-customer configurations	✅

Others

Function name	Description	Type	Source code
`create-ad-account-report`	Request an async ad account analytics report.	Action	🔗 Github
`create-ad-account`	Create an ad account.	Action	🔗 Github
`create-ad-groups`	Create one or more ad groups.	Action	🔗 Github
`create-ads`	Create one or more ads.	Action	🔗 Github
`create-advertiser-defined-events`	Create custom advertiser-defined conversion event definitions.	Action	🔗 Github
`create-audience`	Create an audience.	Action	🔗 Github
`create-board-section`	Create a board section.	Action	🔗 Github
`create-board`	Create a board.	Action	🔗 Github
`create-campaign`	Create a campaign.	Action	🔗 Github
`create-conversion-tag`	Create a conversion (tracking) tag.	Action	🔗 Github
`create-customer-list`	Create a customer (match audience) list.	Action	🔗 Github
`create-customer-segment`	Create a customer segment from existing audiences.	Action	🔗 Github
`create-keywords`	Create targeting keywords	Action	🔗 Github
`create-labels`	Create ad-entity labels.	Action	🔗 Github
`create-lead-ads-subscription`	Create a webhook subscription for new lead submissions.	Action	🔗 Github
`create-lead-forms`	Create lead-generation ad forms.	Action	🔗 Github
`create-targeting-template`	Create a reusable targeting template.	Action	🔗 Github
`delete-advertiser-defined-events`	Delete custom advertiser-defined conversion event definitions.	Action	🔗 Github
`delete-board-section`	Delete a board section.	Action	🔗 Github
`delete-board`	Delete a board.	Action	🔗 Github
`delete-lead-ads-subscription`	Delete a lead ads webhook subscription.	Action	🔗 Github
`delete-pin`	Delete a pin.	Action	🔗 Github
`delete-promotion`	Delete a Shopping ad promotion.	Action	🔗 Github
`get-ad-account-analytics`	Get account-level analytics	Action	🔗 Github
`get-ad-account-report`	Get the async ad account analytics report previously requested.	Action	🔗 Github
`get-ad-account`	Retrieve an ad account	Action	🔗 Github
`get-ad-group-analytics`	Get ad-group-level analytics.	Action	🔗 Github
`get-ad-group-audience-sizing`	Estimate reachable audience size for a targeting spec.	Action	🔗 Github
`get-ad-group`	Retrieve an ad group.	Action	🔗 Github
`get-audience`	Retrieve an audience	Action	🔗 Github
`get-bid-floors`	Get the minimum allowed bid for given objective/billable-event combinations.	Action	🔗 Github
`get-board-section-pins`	List pins within a specific board section	Action	🔗 Github
`get-board`	Retrieve a board.	Action	🔗 Github
`get-campaign-analytics`	Get campaign-level analytics.	Action	🔗 Github
`get-campaign`	Retrieve a campaign.	Action	🔗 Github
`get-conversion-tag`	Retrieve a conversion tag.	Action	🔗 Github
`get-customer-list`	Retrieve a customer list	Action	🔗 Github
`get-featured-trend-topics`	Get Pinterest's featured trending topics for a region.	Action	🔗 Github
`get-interest-targeting-details`	Get details for a specific interest-targeting option.	Action	🔗 Github
`get-keyword-metrics`	Get search-volume metrics for keywords in a country.	Action	🔗 Github
`get-lead-ads-subscription`	Retrieve a lead ads webhook subscription.	Action	🔗 Github
`get-media-upload`	Get the processing status of a registered media upload.	Action	🔗 Github
`get-metrics-ready-state`	Check whether recent analytics data has fully landed (avoid reading partial data).	Action	🔗 Github
`get-ocpm-eligible-conversion-tags`	List conversion tags eligible for oCPM bidding.	Action	🔗 Github
`get-page-visit-conversion-tags`	Get page visit conversion tags	Action	🔗 Github
`get-pin`	Retrieve a Pin.	Action	🔗 Github
`get-product-category-trend-details`	Get trend details for specific Shopping product categories.	Action	🔗 Github
`get-promotion`	Retrieve a Shopping ad promotion.	Action	🔗 Github
`get-related-terms`	Get terms related to a given term.	Action	🔗 Github
`get-suggested-terms`	Get suggested search terms.	Action	🔗 Github
`get-targeting-options`	Look up valid targeting option values (e.g. interests, locations) by type.	Action	🔗 Github
`get-trending-editorial-articles`	Get Pinterest editorial trend articles for a region.	Action	🔗 Github
`get-trending-keywords`	Get top trending search keywords for a region.	Action	🔗 Github
`get-trending-product-categories`	Get growing Shopping product categories.	Action	🔗 Github
`get-user-account-analytics`	Get organic account analytics.	Action	🔗 Github
`get-user-account-top-pins`	Get top-performing organic pins analytics	Action	🔗 Github
`get-user-account-top-video-pins`	Get top-performing organic video pins analytics.	Action	🔗 Github
`get-user-account`	Retrieve the connected user account profile.	Action	🔗 Github
`get-user-websites`	List claimed/verified websites for the account.	Action	🔗 Github
`get-website-verification-code`	Get the meta-tag/HTML-file verification code for claiming a website.	Action	🔗 Github
`list-ad-account-countries`	List countries available for ad account creation/targeting.	Action	🔗 Github
`list-ad-accounts`	List ad accounts.	Action	🔗 Github
`list-ad-groups`	List ad groups.	Action	🔗 Github
`list-ads`	List ads.	Action	🔗 Github
`list-advertiser-defined-events`	List custom advertiser-defined conversion event definitions.	Action	🔗 Github
`list-audiences`	List audiences for an ad account.	Action	🔗 Github
`list-board-pins`	List pins on a board	Action	🔗 Github
`list-board-sections`	List sections on a board.	Action	🔗 Github
`list-boards`	List boards.	Action	🔗 Github
`list-campaigns`	List campaigns.	Action	🔗 Github
`list-catalog-feeds`	List catalog data feeds.	Action	🔗 Github
`list-catalogs`	List product catalogs	Action	🔗 Github
`list-conversion-tags`	List conversion (tracking) tags.	Action	🔗 Github
`list-customer-lists`	List uploaded customer (match audience) lists.	Action	🔗 Github
`list-customer-segments`	List customer segments (combinations of audiences).	Action	🔗 Github
`list-delivery-metrics`	List available analytics metric definitions	Action	🔗 Github
`list-followers`	List followers of the account.	Action	🔗 Github
`list-following-boards`	List boards the user follows.	Action	🔗 Github
`list-following-interests`	List interests the user follows.	Action	🔗 Github
`list-following`	List accounts the user follows.	Action	🔗 Github
`list-keywords`	List targeting keywords for an ad account's ad groups.	Action	🔗 Github
`list-lead-ads-subscriptions`	List webhook subscriptions for new lead submissions.	Action	🔗 Github
`list-lead-forms`	List lead-generation ad forms.	Action	🔗 Github
`list-linked-businesses`	List businesses linked to the account.	Action	🔗 Github
`list-order-lines`	List insertion-order line items billed to the ad account.	Action	🔗 Github
`list-pin-product-tags`	Get product tags on a pin.	Action	🔗 Github
`list-pins`	List pins owned by the account.	Action	🔗 Github
`list-product-group-promotions`	List product-group-level promotion overrides.	Action	🔗 Github
`list-promotions`	List Shopping ad promotions.	Action	🔗 Github
`list-targeting-templates`	List reusable targeting templates.	Action	🔗 Github
`register-media-upload`	Register a media upload and get a signed upload URL.	Action	🔗 Github
`save-pin`	Save (repin) an existing pin to one of your boards.	Action	🔗 Github
`search-boards`	Search the account's own boards.	Action	🔗 Github
`search-pins`	Search the account's own pins.	Action	🔗 Github
`send-conversion-events`	Send server-side conversion events (Conversions API).	Action	🔗 Github
`unverify-website`	Remove verification for a claimed website.	Action	🔗 Github
`update-ad-groups`	Update one or more ad groups.	Action	🔗 Github
`update-advertiser-defined-events`	Update custom advertiser-defined conversion event definitions	Action	🔗 Github
`update-audience`	Update an audience (e.g. rename or archive it).	Action	🔗 Github
`update-board-section`	Update a board section.	Action	🔗 Github
`update-board`	Update a board.	Action	🔗 Github
`update-campaigns`	Update one or more campaigns.	Action	🔗 Github
`update-customer-list`	Add or remove records on an existing customer list.	Action	🔗 Github
`update-customer-segments`	Update customer segments.	Action	🔗 Github
`update-keywords`	Update targeting keywords.	Action	🔗 Github
`update-targeting-templates`	Update targeting templates	Action	🔗 Github
`ad-accounts`	Sync ad accounts.	Sync	🔗 Github
`ad-groups`	Sync ad groups.	Sync	🔗 Github
`ads`	Sync ads.	Sync	🔗 Github
`analytics`	Sync campaign-level analytics as a rolling date-window snapshot	Sync	🔗 Github
`audiences`	Sync audiences.	Sync	🔗 Github
`board-sections`	Sync sections for every board.	Sync	🔗 Github
`boards`	Sync boards.	Sync	🔗 Github
`campaigns`	Sync campaigns.	Sync	🔗 Github
`catalog-feeds`	Sync catalog data feeds.	Sync	🔗 Github
`catalog-product-groups`	Sync catalog product groups.	Sync	🔗 Github
`catalogs`	Sync product catalogs	Sync	🔗 Github
`conversion-tags`	Sync conversion (tracking) tags.	Sync	🔗 Github
`customer-lists`	Sync customer (match audience) lists.	Sync	🔗 Github
`customer-segments`	Sync customer segments.	Sync	🔗 Github
`keywords`	Sync targeting keywords.	Sync	🔗 Github
`lead-forms`	Sync lead-generation ad forms	Sync	🔗 Github
`order-lines`	Sync insertion-order line items.	Sync	🔗 Github
`pins`	Sync pins.	Sync	🔗 Github
`promotions`	Sync Shopping ad promotions	Sync	🔗 Github
`targeting-templates`	Sync reusable targeting templates	Sync	🔗 Github
`user-account`	Sync the connected user account profile as a single-record snapshot.	Sync	🔗 Github

Access requirements

Pre-Requisites	Status	Comment
Paid dev account	❓
Paid test account	❓
Partnership	❓
App review	❓
Security audit	❓

Setup guide

No setup guide yet.

Need help getting started? Get help in the community.

Contribute improvements to the setup guide by editing this page

Useful links

Contribute useful links by editing this page

API gotchas

Access tokens expire within 30 days (2592000 seconds) of being issued. Refresh tokens last for 365 days (31536000 seconds)

Contribute API gotchas by editing this page

Overview

Pre-built tooling

Pre-built integrations

Access requirements

Setup guide

Useful links

API gotchas

Pre-built tooling

Others

Access requirements

Setup guide

Useful links

API gotchas

On this page

Pinterest

OverviewCopy Anchor Link

Pre-built tooling

Pre-built integrations

Access requirements

Setup guide

Useful links

API gotchas

Pre-built toolingCopy Anchor Link

OthersCopy Anchor Link

Access requirementsCopy Anchor Link

Setup guideCopy Anchor Link

Useful linksCopy Anchor Link

API gotchasCopy Anchor Link

On this page

Overview

Pre-built tooling

Others

Access requirements

Setup guide

Useful links

API gotchas