Help Center

Menu

Pinterest

Pinterest Component is designed to interact with Pinterest REST API. The current release of the component supports API version 5, tested on 5.11.0.

Credentials

You need to set up an app to get the required credentials.

Component credentials configuration fields:

Type

A required drop-down. Set this to OAuth2 or No Auth for Sandbox.

Choose Auth Client

A required drop-down. Select one of the created before or Add New Auth Client:

Name

A required string. Provide a name you want.

Client ID

A required string. Enter your application’s App ID.

Client Secret

A required string. Enter your application’s Secret Key.

Authorization Endpoint

A required string. Enter the Pinterest OAuth2 authorization endpoint: https://www.pinterest.com/oauth/

Token Endpoint

A required string. Enter the Pinterest refresh token endpoint https://api.pinterest.com/v5/oauth/token

Name Your Credential

A required string. Provide a name.

Scopes (Comma-separated list)

A required string. Enter the scopes required to access Pinterest. For example, boards:read,pins:read,user_accounts:read. Read the Pinterest Scopes documentation for more information.

You must include the user_accounts:read scope to verify your credentials.
Additional parameters (Comma-separated list)

An optional string field. Enter any optional parameters to be used.

OpenAPI JSON file location

An optional string. An OpenAPI description of Pinterest’s REST API in JSON format. The component uses the local file version: 5.11.0 by default. For example, https://raw.githubusercontent.com/pinterest/api-description/main/v5/openapi.json.

Sandbox access token

An optional string. This must be empty for OAuth2. For No Auth this field is mandatory. The Sandbox API will be used instead of the production.

Triggers

The Pinterest component has no trigger functions. This means it will not be accessible to select as a first component during the integration flow design.

Actions

Make api call

This action is used to call any Pinterest endpoint.

Configuration fields

Select an endpoint

A required dropdown. Select one of the available endpoints. For example, GET /pins (List Pins)

Enable pagination

An optional checkbox. If selected, and an endpoint supports pagination, the component will automatically go through all pages and emit all of them one by one.

Input metadata

Each field is auto-generated based on the endpoint selected

Parameters from the path

An optional object. Required fields with which to build a correct path. For example, if the endpoint looks like this /boards/{board_id}/pins, it will be board_id.

Request parameters

An optional string. Additional parameters for the request.

Request body

An optional string. A request body if the endpoint supports it.

Output metadata

This will be the response body.

Make raw request

Executes custom requests.

Configuration fields

Don’t throw error on 404 Response

An optional boolean. Do not treat 404 HTTP responses as an error. This is false by default.

Input metadata

URL

A required string. Path of the resource relative to the base URL.

Method

A required string. HTTP verb to use in the request, one of GET, POST, PUT, PATCH, DELETE.

Request Body

An optional object. Body of the request to send.

Output metadata

Status Code

A required number. HTTP status code of the response.

HTTP headers

A required object. HTTP headers of the response.

Response Body

An optional object. HTTP response body.