# Pinterest API

> Pinterest's developer platform for building integrations with the Pinterest API.
> Use this documentation to learn about authentication, managing organic content,
> running ads, working with catalogs, tracking conversions, and accessing analytics.

## API Specification

- [Pinterest API v5 OpenAPI Specification](https://raw.githubusercontent.com/pinterest/api-description/main/v5/openapi.yaml): Raw OpenAPI specification for the Pinterest API v5

## API Reference

- [API v5 Interactive Reference](https://developers.pinterest.com/docs/api/v5/): Browse all API v5 endpoints with request/response examples

## Documentation

### Overview
- [Overview](https://developers.pinterest.com/docs/overview/welcome.md)

### Getting started
- [1. Connect app](https://developers.pinterest.com/docs/getting-started/connect-app.md)
- [2. Set up authentication and authorization](https://developers.pinterest.com/docs/getting-started/set-up-authentication-and-authorization.md)
- [3. Make an API call](https://developers.pinterest.com/docs/getting-started/make-an-api-call.md)

### Key concepts
- [Access tiers](https://developers.pinterest.com/docs/key-concepts/access-tiers.md)
- [Pinterest entities](https://developers.pinterest.com/docs/key-concepts/pinterest-entities.md)
- [Best practices](https://developers.pinterest.com/docs/key-concepts/best-practices.md)
- [Using beta and restricted features](https://developers.pinterest.com/docs/key-concepts/using-beta-and-restricted-features.md)

### Work with organic content and users
- [Create boards and pins](https://developers.pinterest.com/docs/work-with-organic-content-and-users/create-boards-and-pins.md)
- [Manage user accounts](https://developers.pinterest.com/docs/work-with-organic-content-and-users/manage-user-accounts.md)

### Work with ads
- [Ads overview](https://developers.pinterest.com/docs/work-with-ads/ads-overview.md)
- [Share business access](https://developers.pinterest.com/docs/work-with-ads/share-business-access.md)

#### Manage campaigns and ad groups
- [Create campaigns and ad groups](https://developers.pinterest.com/docs/work-with-ads/create-campaigns-and-ad-groups.md)
- [Try out campaign objective type simplification](https://developers.pinterest.com/docs/work-with-ads/try-out-campaign-objective-type-simplification.md)
- [Create promotions](https://developers.pinterest.com/docs/work-with-ads/promotions.md)
- [Enable Pinterest Performance+ in campaigns](https://developers.pinterest.com/docs/work-with-ads/pinterest-performance-plus-setup.md)
- [Use Pinterest Performance+ Creative](https://developers.pinterest.com/docs/work-with-ads/pinterest-performance-plus-creative.md)
- [Use Media Planner with the Pinterest API](https://developers.pinterest.com/docs/work-with-ads/use-media-planner-in-the-api.md)

- [Managing ads](https://developers.pinterest.com/docs/work-with-ads/managing-ads.md)
- [Lead ads](https://developers.pinterest.com/docs/work-with-ads/lead-ads.md)
- [Generate shareable ad previews](https://developers.pinterest.com/docs/work-with-ads/generate-shareable-ad-previews.md)
- [Integrate MikMak shopper where-to-buy links](https://developers.pinterest.com/docs/work-with-ads/where-to-buy-links.md)
- [Bulk actions](https://developers.pinterest.com/docs/work-with-ads/bulk-actions.md)

### Work with analytics and reports
- [Analytics overview](https://developers.pinterest.com/docs/analytics-and-reports/analytics-overview.md)
- [Ads reporting](https://developers.pinterest.com/docs/analytics-and-reports/ads-reporting.md)
- [Organic reporting](https://developers.pinterest.com/docs/analytics-and-reports/organic-reporting.md)
- [Audience insights](https://developers.pinterest.com/docs/analytics-and-reports/audience-insights.md)
- [Trends](https://developers.pinterest.com/docs/analytics-and-reports/trends.md)
- [Metrics glossary](https://developers.pinterest.com/docs/analytics-and-reports/metrics-glossary.md)

### Work with catalogs
- [Work with catalogs and product groups](https://developers.pinterest.com/docs/work-with-catalogs/shopping-overview.md)
- [Best practices](https://developers.pinterest.com/docs/work-with-catalogs/shopping-best-practices.md)
- [Manage with a feed](https://developers.pinterest.com/docs/work-with-catalogs/manage-with-a-feed.md)
- [Use multi-image templates in product ads](https://developers.pinterest.com/docs/work-with-catalogs/use-multi-image-templates-in-product-ads.md)
- [Modify items in batch](https://developers.pinterest.com/docs/work-with-catalogs/modify-items-in-batch.md)
- [Manage local store inventory](https://developers.pinterest.com/docs/work-with-catalogs/manage-local-store-inventory.md)
- [Manage product groups](https://developers.pinterest.com/docs/work-with-catalogs/manage-product-groups.md)
- [Diagnostics](https://developers.pinterest.com/docs/work-with-catalogs/diagnostics.md)

### Work with targets and audiences
- [Set up targets for your ads](https://developers.pinterest.com/docs/work-with-targets-and-audiences/set-up-targets-for-your-ads.md)
- [Create audiences](https://developers.pinterest.com/docs/work-with-targets-and-audiences/create-audiences.md)
- [Use asynchronous upload jobs for large customer lists](https://developers.pinterest.com/docs/work-with-targets-and-audiences/use-asynchronous-upload-jobs-for-large-customer-lists.md)
- [Share audiences](https://developers.pinterest.com/docs/work-with-targets-and-audiences/share-audiences.md)

### Track conversions
- [Track conversions in the API](https://developers.pinterest.com/docs/track-conversions/track-conversions-in-the-api.md)
- [Define your own event types](https://developers.pinterest.com/docs/track-conversions/define-your-own-event-types.md)
- [Remove users from events](https://developers.pinterest.com/docs/track-conversions/remove-users-from-events.md)
- [Get Event Quality Score for conversions](https://developers.pinterest.com/docs/track-conversions/get-event-quality-score.md)

#### Use Pinterest Tag and Tag Helper
- [Track conversions with Pinterest Tag](https://developers.pinterest.com/docs/track-conversions/pinterest-tag.md)
- [Use Pinterest Tag Helper](https://developers.pinterest.com/docs/track-conversions/use-pinterest-tag-helper.md)

- [Integrate third-party tracking tools](https://developers.pinterest.com/docs/track-conversions/integrate-third-party-tracking-tools.md)
- [Use Limited Data Processing flag](https://developers.pinterest.com/docs/track-conversions/use-limited-data-processing-flag.md)

### Developer tools
- [SDK](https://developers.pinterest.com/docs/developer-tools/sdk.md)
- [Sandbox](https://developers.pinterest.com/docs/developer-tools/sandbox.md)
- [Quickstart tools](https://developers.pinterest.com/docs/developer-tools/quickstart-tools.md)
- [Token Debugger](https://developers.pinterest.com/docs/developer-tools/token-debugger.md)

### Reference
- [Rate limits](https://developers.pinterest.com/docs/reference/rate-limits.md)
- [Schema standardization of optional nullable fields](https://developers.pinterest.com/docs/reference/schema-standardization-of-optional-nullable-fields.md)
- [Error codes](https://developers.pinterest.com/docs/reference/error-codes.md)
- [Pagination](https://developers.pinterest.com/docs/reference/pagination.md)
- [Image proxy requests to your website](https://developers.pinterest.com/docs/reference/image-proxy-requests-to-your-website.md)
- [Help & feedback](https://developers.pinterest.com/docs/reference/help-and-feedback.md)
- [Manage notifications](https://developers.pinterest.com/docs/reference/manage-notifications.md)
- [Control Pinterestbot access to your site](https://developers.pinterest.com/docs/reference/control-pinterestbot-access-to-your-site.md)

## Optional

### Changelog
- [Changelog](https://developers.pinterest.com/docs/changelog/changelog.md)

### FAQs
- [FAQs](https://developers.pinterest.com/docs/faqs/faqs.md)

### Web features

#### Add ons
- [Add ons overview](https://developers.pinterest.com/docs/web-features/add-ons-overview.md)
- [Buttons](https://developers.pinterest.com/docs/web-features/buttons.md)
- [Widgets](https://developers.pinterest.com/docs/web-features/widgets.md)


#### Rich pins
- [Rich pins overview](https://developers.pinterest.com/docs/web-features/rich-pins-overview.md)
- [Article Rich Pins](https://developers.pinterest.com/docs/web-features/article-rich-pins.md)
- [Product Rich Pins](https://developers.pinterest.com/docs/web-features/product-rich-pins.md)
- [Recipe Rich Pins](https://developers.pinterest.com/docs/web-features/recipe-rich-pins.md)