# Pinterest Board API

Pinterest

Returns a public Pinterest board from its link, a section's link, a pin.it short link or its ID. It has the name, description, cover, the owner, exact pin and follower counts, and the date it was created. It also says whether the board is collaborative, lists its collaborators, counts its sections and names the interests Pinterest relates it to. A section's link returns that section, with the board it belongs to.

GET `/v1/pinterest/board`

## Example

cURL:

```shell
curl -G 'https://socialtap.dev/v1/pinterest/board' \
  --data-urlencode 'url=https://www.pinterest.com/chamberlaincoffeepins/the-wilderkind-collection/' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
```

TypeScript SDK:

```typescript
import { SocialTap } from "socialtap";

const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY

const res = await client.pinterest.board.get({ url: "https://www.pinterest.com/chamberlaincoffeepins/the-wilderkind-collection/" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
```

Node.js (fetch):

```javascript
const params = new URLSearchParams({
  url: "https://www.pinterest.com/chamberlaincoffeepins/the-wilderkind-collection/",
});
const res = await fetch(`https://socialtap.dev/v1/pinterest/board?${params}`, {
  headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, meta } = body;
console.log(data, meta.credits_charged);
```

Python (requests):

```python
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/pinterest/board",
    params={"url": "https://www.pinterest.com/chamberlaincoffeepins/the-wilderkind-collection/"},
    headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, meta = body["data"], body["meta"]
print(data, meta["credits_charged"])
```

Go (net/http):

```go
package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/url"
	"os"
)

func main() {
	q := url.Values{}
	q.Set("url", "https://www.pinterest.com/chamberlaincoffeepins/the-wilderkind-collection/")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/pinterest/board?"+q.Encode(), nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer res.Body.Close()
	var body struct {
		Data  json.RawMessage `json:"data"`
		Meta  map[string]any  `json:"meta"`
		Error *struct {
			Code    string `json:"code"`
			Message string `json:"message"`
		} `json:"error"`
	}
	if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
		log.Fatal(err)
	}
	if body.Error != nil {
		log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
	}
	fmt.Println(string(body.Data), body.Meta["credits_charged"])
}
```

200 OK:

```json
{
  "data": {
    "approximate_fields": [],
    "description": "Inspired by the Pinterest Predicts trend, Wilderkind, this limited-edition collection is made for slowing down, getting outside, and finding beauty in everyday moments. #PinterestPartner",
    "id": "1136033143445898365",
    "is_collaborative": true,
    "metrics": {
      "post_count": 45
    },
    "owner": {
      "avatar_url": "https://i.pinimg.com/280x280_RS/b1/a8/bd/b1a8bd69c78a85bf68ed7d613b978afe.jpg",
      "display_name": "Chamberlain Coffee",
      "id": "1136033212162710003",
      "is_verified": false,
      "url": "https://www.pinterest.com/chamberlaincoffeepins/",
      "username": "chamberlaincoffeepins"
    },
    "platform": "pinterest",
    "platform_specific": {
      "pinterest": {
        "board": null,
        "collaborator_count": 3,
        "collaborators": [
          {
            "avatar_url": "https://i.pinimg.com/280x280_RS/1c/b5/61/1cb561c8e7b9c709f78d110a4b5f0863.jpg",
            "display_name": "Pinterest",
            "id": "424605208526455283",
            "is_verified": true,
            "url": "https://www.pinterest.com/pinterest/",
            "username": "pinterest"
          },
          {
            "avatar_url": "https://i.pinimg.com/280x280_RS/fa/e4/eb/fae4eb8762dcd3d5e5186a2b034eafa2.jpg",
            "display_name": "Pop Culture",
            "id": "902057137772158742",
            "is_verified": true,
            "url": "https://www.pinterest.com/popculture/",
            "username": "popculture"
          },
          {
            "avatar_url": "https://i.pinimg.com/280x280_RS/50/64/63/50646339f8fb7668d5467c9356490d88.jpg",
            "display_name": "emma chamberlain",
            "id": "335729484630074012",
            "is_verified": true,
            "url": "https://www.pinterest.com/emmafranceschamberlain/",
            "username": "emmafranceschamberlain"
          }
        ],
        "created_at": "2026-09-10T22:22:46Z",
        "follower_count": 8405,
        "interests": [
          "Emma Chamberlain",
          "Find Beauty",
          "Get Outside"
        ],
        "privacy": "public",
        "section_count": 0
      }
    },
    "platform_type": "board",
    "thumbnail_url": "https://i.pinimg.com/474x/4c/90/fb/4c90fb11eaf57db4804c91cc4d8982fc.jpg",
    "title": "The Wilderkind Collection",
    "type": "collection",
    "unknown_fields": [],
    "url": "https://www.pinterest.com/chamberlaincoffeepins/the-wilderkind-collection/"
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "pinterest",
    "source": "api",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 0,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": {
      "kind": "playlist",
      "id": "1136033143445898365",
      "url": "https://www.pinterest.com/chamberlaincoffeepins/the-wilderkind-collection/"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}
```

Long arrays and strings are shortened for display; real responses are complete.

> [!NOTE]
>
> **Good to know**
>
> - A section's link returns the section: platform_type is section, metrics.post_count counts its pins, and platform_specific.pinterest.board names its board. A section has no cover of its own in Pinterest's answer, so thumbnail_url is null.
> - platform_specific.pinterest.collaborators lists at most ten collaborators, as Pinterest does; collaborator_count counts them all.
> - Pinterest answers that a board is not there for secret boards and for some group boards it still lists on the owner's profile, so both return not_found.
> - When Pinterest's main API fails, the board comes from its embed API, which has no creation date, privacy, collaborators, sections or interests, and no section links.

## Authorizations

`x-api-key`stringheaderrequired

Your API key. [Authentication](https://socialtap.dev/docs/authentication/index.md)

## Query parameters

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `url` required | `string`<br>max 2,048 chars | The board: its link (pinterest.com/\<username>/\<board>/, also on a country's site such as uk.pinterest.com or pinterest.co.uk), a link to one of its sections (pinterest.com/ikeausa/living-rooms/sofas-armchairs/), a short link (pin.it/\<code>) or its ID. | `https://www.pinterest.com/pinterest/easy-and-chic-holiday-nail-ideas/` |

`url` takes Pinterest playlist links; another kind of link, or another platform's, fails free with [`invalid_input`](https://socialtap.dev/docs/errors/index.md#invalid_input). Unknown parameters are rejected with a suggestion, never ignored ([Requests](https://socialtap.dev/docs/requests/index.md)).

**Parameters every endpoint accepts**

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `max_age` optional | `integer`<br>min 0 | Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. | — |
| `fields` optional | `string` | Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments\[\].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole. | — |

## Response

### 200

`{data, meta}`. `data` is a [playlist](https://socialtap.dev/resources/playlist/index.md) object; `meta` describes the request ([meta](https://socialtap.dev/docs/reference/index.md#meta)). Fields only Pinterest has are under `platform_specific.pinterest`.

| Field | Type | Description |
| --- | --- | --- |
| `data.platform` | `string` | Platform ID (tiktok, youtube, facebook, …). |
| `data.id` | `string` | Platform-native playlist ID (string): TikTok's playlist (mix) or collection ID, YouTube's list ID (PL…), Facebook's video list ID. |
| `data.url` | `string` (uri) | Canonical playlist URL. |
| `data.type` | `string` | playlist: a list its owner curates and orders (TikTok playlists, YouTube playlists, Facebook playlists and series); collection: posts an account saved from any creator into a named public folder (TikTok collections). New values may be added; treat unknown values as playlist.<br>One of `playlist`, `collection` |
| `data.platform_type` | `string` or `null` | The platform's own label, lowercase (mix, collection, playlist, series, podcast, …). |
| `data.title` | `string` or `null` | Name its owner gave it. |
| `data.description` | `string` or `null` | Description as plain text; null when it has none or the platform shows none (TikTok). |
| `data.owner` | `object` | The account that curates it (for a collection, the account that saved the posts, not their authors). Where a platform's curators are not accounts (Apple Music), what it states of them: a name, perhaps a page and a picture, with id and username null, and every field null when it names no one. |
| `data.owner.id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `data.owner.username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data.owner.display_name` | `string` or `null` | Display name shown on the profile. |
| `data.owner.url` | `string` (uri) or `null` | Canonical profile URL. |
| `data.owner.avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `data.owner.is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data.thumbnail_url` | `string` (uri) or `null` | Cover image URL (the owner's chosen cover, else the platform's pick, often the first post's). Platform CDN URLs can expire within hours. |
| `data.is_collaborative` | `boolean` or `null` | Whether people its owner invites can add to it as well (a collaborative playlist, a group board); null where the platform doesn't say. |
| `data.metrics` | `object` | Counts at fetch time; null = hidden or not exposed, 0 = zero. |
| `data.metrics.post_count` | `integer` or `null` | Posts in it as the platform counts them (it may count posts that are no longer public, so a walk of its posts can return fewer). |
| `data.platform_specific` | `object` | Fields only this platform has, under its ID (platform_specific.\<platform>); each null when unknown. |
| `data.platform_specific.pinterest` | `object` or `null` | A Pinterest board's or board section's own fields. |
| `data.platform_specific.pinterest.follower_count` | `integer` or `null` | Accounts following the board, exact; null on a section, which has no followers of its own. |
| `data.platform_specific.pinterest.created_at` | `string` (date-time) or `null` | When the board was created, RFC 3339 UTC; null on a section and when the source does not state it. |
| `data.platform_specific.pinterest.privacy` | `string` or `null` | public, or protected: a board Pinterest keeps off its owner's profile and out of search engines but shows anyone with its link (a shop's catalog of products). New values may be added. |
| `data.platform_specific.pinterest.collaborator_count` | `integer` or `null` | Accounts other than its owner that can save pins to the board, exact; 0 on a board only its owner saves to. |
| `data.platform_specific.pinterest.collaborators` | `object[]` | The accounts other than its owner that can save pins to the board, as Pinterest lists them; \[\] when none. |
| `data.platform_specific.pinterest.collaborators[].id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `data.platform_specific.pinterest.collaborators[].username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data.platform_specific.pinterest.collaborators[].display_name` | `string` or `null` | Display name shown on the profile. |
| `data.platform_specific.pinterest.collaborators[].url` | `string` (uri) or `null` | Canonical profile URL. |
| `data.platform_specific.pinterest.collaborators[].avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `data.platform_specific.pinterest.collaborators[].is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data.platform_specific.pinterest.section_count` | `integer` or `null` | Sections the board is divided into; 0 when none, null on a section. |
| `data.platform_specific.pinterest.interests` | `string[]` | The interests Pinterest relates the board to, each an ideas page of its own, in its order; \[\] when none. |
| `data.platform_specific.pinterest.board` | `object` or `null` | For a section, the board it is part of; null on a board. |
| `data.platform_specific.pinterest.board.id` | `string` or `null` | The board's ID. |
| `data.platform_specific.pinterest.board.title` | `string` or `null` | The board's name. |
| `data.platform_specific.pinterest.board.url` | `string` (uri) or `null` | The board's link. |
| `data.approximate_fields` | `string[]` | JSON paths of values rounded by the platform, date-only or parsed from display text. \[\] when all exact. |
| `data.unknown_fields` | `string[]` | JSON paths of lists whose \[\] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. \[\] when every list is known. |

not_found and private_or_unavailable are item-level: the request was fine, the item can't be returned.

### 400

400 Bad Request: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `invalid_input` | 400 | No | A parameter is missing or malformed, or the link is not one this endpoint takes. | Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one. |

### 401

401 Unauthorized: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `unauthorized` | 401 | No | The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired. | Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url. |

### 402

402 Payment Required: 2 error codes. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `insufficient_credits` | 402 | No | The account does not have enough credits for this request. | Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically. |
| `spend_limit_reached` | 402 | No | The API key reached its spend limit for this period. The account may still have credits. | Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically. |

### 403

403 Forbidden: 2 error codes. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `forbidden` | 403 | No | The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code. | Act on details.reason. suspended: contact [support](mailto:support@socialtap.dev). scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP. |
| `private_or_unavailable` | 403 | No | The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code. | Only public items can be fetched. Do not retry. |

### 404

404 Not Found: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `not_found` | 404 | No | The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why). | Check the link or ID. Do not retry. |

### 429

429 Too Many Requests: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `rate_limited` | 429 | Yes, later | The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it. | Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask [support](mailto:support@socialtap.dev) to raise the ceiling; without an API key, send one. |

### 500

500 Internal Error: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `internal` | 500 | Yes, later | An unexpected error on SocialTap's side. | Retry with backoff. If it keeps happening, contact [support](mailto:support@socialtap.dev) with the request_id. |

### 502

502 Bad Gateway: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_error` | 502 | Yes, later | The platform failed, or answered with something we could not read. | Retry with backoff. Failed requests are free. |

### 503

503 Unavailable: 2 error codes. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_blocked` | 503 | Yes, later | The platform refused every attempt, our own retries included. | Retry later with backoff. Failed requests are free. |
| `overloaded` | 503 | Yes, later | SocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged. | Retry after the seconds in the retry-after header. Failed requests are free. |

## Pricing

From **1 credit** per request. Charged only for successful requests. Errors are free. The price depends on the source that produced the result, reported as `meta.source`.

| Source | Price per successful request | Per 1,000 requests |
| --- | --- | --- |
| Platform API `api` | 1 credit | $0.75–$1.97 |

**Balance, sources and what you were charged**

Your balance must be at least **1 credit** to start a request; with less, it is refused with [`insufficient_credits`](https://socialtap.dev/docs/errors/index.md#insufficient_credits) (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.

| meta.source | Source | What it means |
| --- | --- | --- |
| `api` | Platform API | The platform's public, logged-out API. |

`meta.credits_charged` and the `x-credits-charged` header show what you paid. [How credits work](https://socialtap.dev/docs/credits/index.md) · [Packs](https://socialtap.dev/pricing/index.md)

Endpoint ID `pinterest.board` · operationId `pinterest.board.get` · [Product overview](https://socialtap.dev/apis/pinterest/board/index.md)

---

[HTML version](https://socialtap.dev/docs/reference/pinterest/board/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)