At a glance
Capabilities
An unsupported call returns501 resource.not_supported.
The cross-platform matrix is on Platforms.
Connect an account
Connect withPOST /v1/accounts/connect and "platform": "pinterest". The shared flow, request fields, and result are in Connect accounts, and the redirect parameters are in Redirect parameters.
- Token lifetime. Pinterest access tokens last 30 days and refresh tokens last 60 days, and each use of a refresh token extends it. SocialAPI renews the access token before it expires, so a connected account keeps working without a reconnect.
- Reconnect. When Pinterest reports that authentication failed, the first call that fails returns
401 platform.pinterest.authand the account is markedtoken_expired. Every later call that acts on the account returns403 account.reconnection_requireduntil you reconnect it. Any other401from Pinterest returns401 platform.pinterest.unauthorizedand leaves the account working: reconnect only if it persists. See Reconnect an account. - Disconnect. Pinterest offers apps no way to end an authorization. Disconnecting an account removes it from SocialAPI, and the person removes SocialAPI’s app in their Pinterest settings.
Boards and Pins are read live
SocialAPI reads boards and Pins from Pinterest on every request and stores neither, because Pinterest’s developer terms forbid storing information read through its API. A board created in the Pinterest app a moment ago appears on the next call, and a call fails when Pinterest is unavailable instead of returning an older list.List Pins
GET /v1/platforms/pinterest/accounts/{id}/pins returns the account’s Pins in the order Pinterest returns them. limit is optional, defaults to 50, and is at most 50. The response holds only the first 50 Pins at most, with no cursor: you cannot page to older Pins. It needs the accounts:read scope.
title carries the Pin’s description, not its separate Pinterest title.
Account summary
GET /v1/platforms/pinterest/accounts/{id}/summary reads the account’s public profile counts from Pinterest at the time of the call. It needs the accounts:read scope. A count Pinterest does not report is 0.
Webhook events
Pinterest sends SocialAPI no events. These SocialAPI events still fire for a Pinterest account:
Every event is described in Webhook events.
Limits
Scopes
SocialAPI’s Pinterest app requests these scopes at connect. You apply for no app review. SocialAPI does not requestboards:read_secret or pins:read_secret. Each scope belongs to the account permissions in the last column, and the consent screen asks for the scopes of the permissions you selected.
Related
- Pinterest publishing: fields, media rules, and quirks for publishing Pins
- Pinterest boards: list, create, rename, and delete boards
- Connect accounts: the shared connect flow
- Platforms: the capability matrix
- Errors: every error code