> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withampersand.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Pinterest

## What's supported

### Supported actions

This connector supports:

* [Read Actions](/read-actions), including full historic backfill. Please note that incremental read is not supported, a full read of the Pinterest instance will be done for each scheduled read.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://api.pinterest.com`.

### Supported objects

The pinterest connector supports reading from the following objects:

* [pins](https://developers.pinterest.com/docs/api/v5/pins-list)
* [boards](https://developers.pinterest.com/docs/api/v5/boards-list)
* [media](https://developers.pinterest.com/docs/api/v5/media-list)
* [ad\_accounts](https://developers.pinterest.com/docs/api/v5/ad_accounts-list)
* [catalogs](https://developers.pinterest.com/docs/api/v5/catalogs-list)
* [employers](https://developers.pinterest.com/docs/api/v5/get-business_employers)
* [feeds](https://developers.pinterest.com/docs/api/v5/feeds-list)
* [product\_groups](https://developers.pinterest.com/docs/api/v5/catalogs_product_groups-list)
* [integrations](https://developers.pinterest.com/docs/api/v5/integrations-get_list)
* [stats](https://developers.pinterest.com/docs/api/v5/reports-stats)

The pinterest connector supports writing from the following objects:

* [pins](https://developers.pinterest.com/docs/api/v5/pins-create)
* [boards](https://developers.pinterest.com/docs/api/v5/boards-create)
* [media](https://developers.pinterest.com/docs/api/v5/media-create)
* [ad\_accounts](https://developers.pinterest.com/docs/api/v5/ad_accounts-create)
* [catalogs](https://developers.pinterest.com/docs/api/v5/catalogs-create)
* [feeds](https://developers.pinterest.com/docs/api/v5/feeds-create)
* [product\_groups](https://developers.pinterest.com/docs/api/v5/catalogs_product_groups-create)
* [websites](https://developers.pinterest.com/docs/api/v5/verify_website-update)
* [commerce](https://developers.pinterest.com/docs/api/v5/integrations_commerce-post)
* [logs](https://developers.pinterest.com/docs/api/v5/integrations_logs-post)
* [reports](https://developers.pinterest.com/docs/api/v5/reports-create)

### Example integration

For an example manifest file of an Pinterest integration, visit our [samples repo on Github](https://github.com/amp-labs/samples/blob/main/pinterest/amp.yaml).

## Before you get started

To integrate Pinterest with Ampersand, you will need a [Pinterest Developer Account](https://developers.pinterest.com/).

Once your account is created, you'll need to create an app in Pinterest, configure the Ampersand redirect URI within the app, and obtain the following credentials from your app:

* App ID
* App Secret
* Scopes

You will then use these credentials and scopes to connect your application to Ampersand.

### Create a Pinterest account

Here's how you can sign up for a Pinterest account:

* Go to the [Pinterest Sign Up page](https://www.pinterest.com/join/) and create a business account.
* Verify your account's email address.
* [Sign In](https://developers.pinterest.com/) to the newly created account and go to **My apps**.
* Click through to accept Pinterest Developer Terms of Service.

### Creating a Pinterest app

Follow the steps below to create a Pinterest app:

1. Log in to your [Pinterest Developer Console](https://developers.pinterest.com/).
2. Click **My Apps**.
3. Click **Connect App**.
4. Enter the app details and click **Submit**.

<img src="https://mintcdn.com/ampersand-24eb5c1a/p4alBfPjHeNuBPh1/images/provider-guides/1cd5402-pinterest1.gif?s=64e2ec289f95c090bc930d42fff2c983" alt="Alt text" width="1440" height="680" data-path="images/provider-guides/1cd5402-pinterest1.gif" />

> 📔 Note
>
> You must submit your app for trial access. Once your access is approved, you can log in to manage your app details on the **My Apps** page, where you can find your app ID and secret.

### Adding Ampersand redirect URL to Pinterest app

1. Log in to your [Pinterest developer console](https://developers.pinterest.com/).

2. Go to **My apps** and select **Manage** for the app you want to configure.

3. On the **Configure** tab scroll to the **Redirect URIs** section and enter the Ampersand **Callback URI**: `https://api.withampersand.com/callbacks/v1/oauth`.

4. Select **Add** to save your changes

<img src="https://mintcdn.com/ampersand-24eb5c1a/p4alBfPjHeNuBPh1/images/provider-guides/0f94f77-pinterest2.gif?s=71aba151f8845e873186be6c6e781fe9" alt="Alt text" width="1440" height="680" data-path="images/provider-guides/0f94f77-pinterest2.gif" />

You'll find the **App ID**, **App Secret**, and **Scopes** keys in the **Configure** section of your app. These credentials are required for connecting your app to Ampersand, so be sure to note them carefully.

## Add Your Pinterest app info to Ampersand

1. Log in to your [Ampersand Dashboard](https://dashboard.withampersand.com).

2. Select the project where you want to create a Pinterest integration.

   <img src="https://mintcdn.com/ampersand-24eb5c1a/CkzFg-K1u4gYx3ZD/images/provider-guides/dd47b7a-Ampersand.png?fit=max&auto=format&n=CkzFg-K1u4gYx3ZD&q=85&s=d580aa00cc421fe14cfbab79c2e0812f" alt="Alt text" width="2244" height="442" data-path="images/provider-guides/dd47b7a-Ampersand.png" />

3. Select **Provider apps**.

4. Select *Pinterest* from the **Provider** list.

5. Enter the previously obtained *App ID* in the **App ID** field and the *App Secret* in the **App Secret** field.

6. Enter the scopes set for your application in *Pinterest*. For more details on the scopes, go to the [Pinterest API Scopes](https://developers.pinterest.com/docs/getting-started/authentication-and-scopes/) documentation.

   <img src="https://mintcdn.com/ampersand-24eb5c1a/Bx3tggG51e0liOp-/images/provider-guides/5acff64-pinterest3.gif?s=6b22a9ccfbd1ec1fe6752cde41578ebf" alt="Alt text" width="772" height="490" data-path="images/provider-guides/5acff64-pinterest3.gif" />

7. Click **Save changes**.

## Using the connector

To start integrating with Pinterest:

* Create a manifest file using the [example](https://github.com/amp-labs/samples/blob/main/pinterest/amp.yaml).
* Deploy it using the [amp CLI](/cli/overview).
* If you are using Read Actions, create a [destination](/destinations).
* Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component.
* Start using the connector!
  * If your integration has [Read Actions](/read-actions), you'll start getting webhook messages.
  * If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API.
  * If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls.
