> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/pinterest/boards/pins/get](https://www.socialfetch.dev/docs/api/v1/pinterest/boards/pins/get)
- **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/pinterest/boards/pins/get.mdx](https://www.socialfetch.dev/docs/api/v1/pinterest/boards/pins/get.mdx)

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/openapi.json)

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [SDK reference](https://www.socialfetch.dev/docs/sdk-reference.mdx) — exhaustive SDK method inventory and route mapping for agents, tooling, and power users.
- [Choose the right endpoint](https://www.socialfetch.dev/docs/choose-endpoint.mdx) — task-oriented route selection for smoke tests, profiles, list endpoints, and single-item lookups.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — fast comparison of identifiers, pagination, outcomes, media download, and SDK coverage.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, SDK, and REST API connection paths.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 87 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).

---
# List Pinterest board pins (https://www.socialfetch.dev/docs/api/v1/pinterest/boards/pins/get)

## Summary

List public pins on a Pinterest board by URL.

**Tags:** `Pinterest`

## HTTP

- **Method:** GET
- **Path:** `/v1/pinterest/boards/pins`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.pinterest.listBoardPins({ url, cursor?, trim? })`
- **Accepted identifiers:** `url` (query)
- **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore`
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`
- **Trimmed response mode:** supported via `trim=true`

## Credits

- **Base:** 1 credit per successful lookup.
- **Maximum on success (200):** 1 credit.
- **Normalization failure (502):** 1 credit charged.
- **Authoritative field:** `meta.creditsCharged`.

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `url` (query)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 4096
- **Description:** Link to the Pinterest board.

### `cursor` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1
- **Description:** Opaque pagination cursor returned by a previous response.

### `trim` (query)

- **Required:** no
- **Description:** When true, returns a smaller response with fewer fields.

## Behavior notes

- **`trim`**: When true, returns a smaller response with fewer fields.

## Pagination

This endpoint uses **cursor-based pagination** via the `cursor` query parameter.

- Read **hasMore** from `data.page.hasMore`.
- When that value is `true`, read **nextCursor** from `data.page.nextCursor` and pass it as the `cursor` query parameter on the **next** request (URL-encode when building a query string).
- Omit `cursor` on the **first** request.
- Stop when **hasMore** is `false` or **nextCursor** is null (end of list).

## Responses (status codes)

- **200**: Pins for the requested board.
- **400**: Invalid query parameters
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed from the response (unexpected or invalid data).
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Pins for the requested board.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the board was found.
  - **pins** (required) — type `array`. Pins returned for this board page.
    - _items:_
      - **id** (required) — type `string`; minLength: 1. Pinterest pin id.
      - **url** (required) — type `string`; nullable. Canonical public pin URL when available.
      - **title** (required) — type `string`; nullable. Pin title when available.
      - **description** (required) — type `string`; nullable. Pin description when available.
      - **link** (required) — type `string`; nullable. Outbound destination link when available.
      - **domain** (required) — type `string`; nullable. Destination domain when available.
      - **dominantColor** (required) — type `string`; nullable. Dominant image color when available.
      - **createdAt** (required) — type `string`; nullable. When the pin was created, when available.
      - **image** (required) — type `object`; nullable. Primary (original) image when available.
        - **url** (required) — type `string`; nullable. Image URL when available.
        - **width** (required) — type `integer`; minimum: 0; nullable. Width in pixels when available.
        - **height** (required) — type `integer`; minimum: 0; nullable. Height in pixels when available.
      - **pinner** (required) — type `object`; nullable. User who pinned this item when available.
        - **id** (required) — type `string`; nullable. Pinterest user id when available.
        - **username** (required) — type `string`; nullable. Pinterest username when available.
        - **fullName** (required) — type `string`; nullable. Display name when available.
        - **avatarUrl** (required) — type `string`; nullable. Profile image URL when available.
      - **board** (required) — type `object`; nullable. Board this pin belongs to when available.
        - **id** (required) — type `string`; nullable. Board id when available.
        - **name** (required) — type `string`; nullable. Board name when available.
        - **url** (required) — type `string`; nullable. Canonical public board URL when available.
      - **metrics** (required) — type `object`. Engagement metrics when available.
        - **saves** (required) — type `integer`; minimum: 0; nullable. Save count when available.
        - **repins** (required) — type `integer`; minimum: 0; nullable. Repin count when available.
  - **page** (required) — type `object`. Pagination state for the current response.
    - **nextCursor** (required) — type `string`; nullable. Cursor to pass in the next request when more results are available.
    - **hasMore** (required) — type `boolean`. Whether another page of results is available.
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "pins": [
      {
        "id": "63894888471739700",
        "url": "https://www.pinterest.com/pin/63894888471739700/",
        "title": "",
        "description": "Love the bun",
        "link": "https://www.shffls.com/shuffles/5371250648050349525",
        "domain": "Uploaded by user",
        "dominantColor": "#ffffff",
        "createdAt": null,
        "image": {
          "url": "https://i.pinimg.com/originals/d6/92/7d/d6927d71dd2f7584453beb1e1f4052fd.jpg",
          "width": 1080,
          "height": 1920
        },
        "pinner": {
          "id": "63895025871749374",
          "username": "lizmrodgers",
          "fullName": "Liz Rodgers - DIY | Home Decor",
          "avatarUrl": "https://i.pinimg.com/75x75_RS/c2/0e/62/c20e628451b24267c68924d01e42c997.jpg"
        },
        "board": {
          "id": "63894957152718519",
          "name": "Moms night",
          "url": "https://www.pinterest.com/lizmrodgers/moms-night/"
        },
        "metrics": {
          "saves": 149,
          "repins": 3
        }
      }
    ],
    "page": {
      "nextCursor": "eyJjIjoiWTJKVVJsRXdUV3N4TmxwNlZrLi4uLiJ9",
      "hasMore": true
    }
  },
  "meta": {
    "requestId": "req_01example",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid query parameters **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed from the response (unexpected or invalid data). **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.pinterest.listBoardPins({
  url: "https://www.pinterest.com/lizmrodgers/moms-night/",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/pinterest/boards/pins?url=https://www.pinterest.com/lizmrodgers/moms-night/",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/pinterest/boards/pins?url=https://www.pinterest.com/lizmrodgers/moms-night/" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/pinterest/boards/pins?url=https://www.pinterest.com/lizmrodgers/moms-night/",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```

### Example: optional query parameters

First request illustrating common optional query flags (adjust values to your integration):

```javascript
const url = "https://api.socialfetch.dev/v1/pinterest/boards/pins?trim=true";
const response = await fetch(url, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const data = await response.json();
```

### Example: next page (pagination)

After a successful response, if pagination is not finished, request the next page using `cursor` (URL-encode when composing the query string):

```javascript
const previous = await response.json();
const nextCursor = previous?.data?.page?.nextCursor;
const hasMore = previous?.data?.page?.hasMore;
if (!hasMore || nextCursor == null) {
  // no more pages
} else {
  const nextUrl = new URL("https://api.socialfetch.dev/v1/pinterest/boards/pins");
  nextUrl.searchParams.set("cursor", nextCursor);
  // optionally preserve sort: nextUrl.searchParams.set("sortBy", "latest");
  const nextResponse = await fetch(nextUrl.toString(), {
    headers: { "x-api-key": "YOUR_API_KEY" },
  });
  const nextData = await nextResponse.json();
}
```