• Installs:
  • Today: 9461
  • All Time: 3043283
Developer:userdimas

Pinterest API Package

Add pins, follow and display options to your app

List of Endpoints
This is the list of endpoints this API includes. To add any of the endpoints to your app, please click on “Connect to endpoint” text.
See All
Discussions
See All
Readme

Pinterest

Pinterest Package

Add pins, follow and display options to your app.

  • Domain: pinterest.com
  • Credentials: clientId, clientSecret

How to get credentials:

  1. You’ll need to be logged in to your Pinterest account to create an app. If you don’t have a Pinterest account, create one now.
  2. To create new app go to Apps
  3. Agree to our terms and policies and click Create app.
  4. Choose a name and description for your app. Be careful, you won’t be able to change the name of your app later. Click Create.
  5. After creation your app you will see Client Id and Client Secret

Pinterest.getAccessToken

This endpoint allows to get back a access token.

FieldTypeDescription
clientIdcredentialsThe Client ID obtained from Pinterest.
clientSecretcredentialsThe Client Secret obtained from Pinterest.
codeStringThe access code you received from your redirect URI.

Pinterest.getUser

This endpoint allows to fetch user data.

FieldTypeDescription
accessTokenStringThe valid access token.

Pinterest.getBoards

This endpoint returns a list of the authenticated user’s public boards, including the URL, ID and name.

FieldTypeDescription
accessTokenStringThe valid access token.

Pinterest.getBoardsSuggestions

This endpoint returns the boards that Pinterest would suggest to the authenticated user if they were to save the specified Pin. The default response returns the ID, URL and name of the boards.

FieldTypeDescription
accessTokenStringThe valid access token.
pinIdStringThe pin_id that you want to return board suggestions for.

Pinterest.getUserLikedPins

This endpoint returns the ID, link, URL and description of the Pins the authenticated user has liked.

FieldTypeDescription
accessTokenStringThe valid access token.
cursorStringPass the cursor value in your next request to receive the next 25 items in the list.

Pinterest.getUserPins

This endpoint returns the ID, link, URL and descriptions of the authenticated user’s Pins.

FieldTypeDescription
accessTokenStringThe valid access token.
cursorStringPass the cursor value in your next request to receive the next 25 items in the list.

Pinterest.searchBoardNames

Searches the authenticated user’s board names (but not Pins on boards). An empty response indicates that nothing was found that matched your search terms. The default response returns the ID, name and URL of boards matching your query.

FieldTypeDescription
accessTokenStringThe valid access token.
queryStringWhat you want to search for.
cursorStringPass the cursor value in your next request to receive the next 25 items in the list.

Pinterest.searchPinDescriptions

Searches the authenticated user’s Pin descriptions. An empty response indicates that nothing was found that matched your search terms. The default response returns the ID, link, URL and description of Pins matching your query.

FieldTypeDescription
accessTokenStringThe valid access token.
queryStringWhat you want to search for.
cursorStringPass the cursor value in your next request to receive the next 25 items in the list.

Pinterest.getFollowers

Returns the users who follow the authenticated user. The default response returns the first and last name, ID and URL of the users.

FieldTypeDescription
accessTokenStringThe valid access token.
cursorStringPass the cursor value in your next request to receive the next 25 items in the list.

Pinterest.getFollowedBoards

Returns the boards that the authenticated user follows. The default response returns the ID, name and URL of the board.

FieldTypeDescription
accessTokenStringThe valid access token.
cursorStringPass the cursor value in your next request to receive the next 25 items in the list.

Pinterest.getFollowedTopics

Returns the topics (e.g, modern architecture, Sherlock) that the authenticated user follows. The default response returns the ID and name of the topic.

FieldTypeDescription
accessTokenStringThe valid access token.
cursorStringPass the cursor value in your next request to receive the next 25 items in the list.

Pinterest.getFollowings

Returns the users that the authenticated user follows. The default response returns the first and last name, ID and URL of the users.

FieldTypeDescription
accessTokenStringThe valid access token.
cursorStringPass the cursor value in your next request to receive the next 25 items in the list.

Pinterest.followBoard

Makes the authenticated user follow the specified board.

FieldTypeDescription
accessTokenStringThe valid access token.
boardStringThe board you want to follow in the format <username>/<board_name>. For example: designboom/technology

Pinterest.followUser

Makes the authenticated user follow the specified user.

FieldTypeDescription
accessTokenStringThe valid access token.
userStringThe username of the user that you want to follow. For example: designboom

Pinterest.unfollowBoard

Makes the authenticated user unfollow the specified board.

FieldTypeDescription
accessTokenStringThe valid access token.
boardStringThe board you want to unfollow in the format <username>/<board_name>. For example: designboom/technology

Pinterest.unfollowUser

Makes the authenticated user unfollow the specified user.

FieldTypeDescription
accessTokenStringThe valid access token.
userStringThe username or user ID of the user you want to unfollow. For example: designboom

Pinterest.createBoard

Creates a board for the authenticated user. The default response returns the ID, URL and name of the created board.

FieldTypeDescription
accessTokenStringThe valid access token.
nameStringThe name of the new board.
descriptionStringThe new board’s description.

Pinterest.getSingleBoard

The default response returns the ID, URL and name of the specified board.

FieldTypeDescription
accessTokenStringThe valid access token.
boardStringThe board you want to fetch in the format <username>/<board_name>. For example: designboom/technology

Pinterest.updateSingleBoard

Changes the chosen board’s name and/or description. The default response returns the ID, URL and name of the edited board.

FieldTypeDescription
accessTokenStringThe valid access token.
boardStringThe board you want to edit in the format <username>/<board_name>. For example: designboom/technology
nameStringThe new board name.
descriptionStringThe new board description.

Pinterest.deleteBoard

Deletes the specified board. This action is permanent and cannot be undone.

FieldTypeDescription
accessTokenStringThe valid access token.
boardStringThe board you want to delete in the format <username>/<board_name>. For example: designboom/technology

Pinterest.createSinglePin

Creates a Pin for the authenticated user. The default response returns the note, URL, link and ID of the created Pin.

FieldTypeDescription
accessTokenStringThe valid access token.
boardStringThe board you want the new Pin to be on. In the format <username>/<board_name>. For example: designboom/technology
noteStringThe Pin’s description.
imageFileUpload the image you want to pin
linkStringThe URL the Pin will link to when you click through.

Pinterest.updateSinglePin

Changes the board, description and/or link of the Pin.

FieldTypeDescription
accessTokenStringThe valid access token.
pinStringThe ID (unique string of numbers and letters) of the Pin you want to edit.
boardStringThe board you want to move the Pin to, in the format <username>/<board_name>. For example: designboom/technology
noteStringThe new Pin description.
linkStringThe new Pin link.

Pinterest.getSinglePin

The default response returns the ID, link, URL and description of the Pin.

FieldTypeDescription
accessTokenStringThe valid access token.
pinStringThe ID (unique string of numbers and letters) of the Pin you want information about.

Pinterest.deleteSinglePin

Deletes the specified Pin. This action is permanent and cannot be undone.

FieldTypeDescription
accessTokenStringThe valid access token.
pinStringThe ID (unique string of numbers and letters) of the Pin you want to delete.

Pinterest.getBoardPins

The default response returns a list of Pins on the board with their ID, URL, link and description.

FieldTypeDescription
accessTokenStringThe valid access token.
boardStringThe board you want to fetch in the format <username>/<board_name>. For example: designboom/technology
cursorStringPass the cursor value in your next request to receive the next 25 items in the list.
x
circle
Pinterest
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Why sign up to RapidAPI?

  • integrate
    Integrate APIs into your app
    Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
  • keys
    Save all API keys in one place
  • notifications
    Get notifications about API changes
  • stats
    Get stats and monitor API connections
__SING_UP_WITH_GITHUB__
__SING_UP_WITH_FACEBOOK__
__SING_UP_WITH_GOOGLE__
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view