Pinterest API Capability

Get Full Board

Compatibility endpoint for bounded board snapshots. For large or complete backups, use pinterest.board-pins.list and follow pagination.next_cursor; unbounded boards over 1,000 pins are rejected instead of returning silent partial data. Pin media includes video_url when recovered plus explicit media_type and media_detection evidence.

Capability ID pinterest.board-full.get

Cost 1 credit per request

Maximum runtime 120 seconds

View raw

# Get Full Board

Compatibility endpoint for bounded board snapshots. For large or complete backups, use pinterest.board-pins.list and follow pagination.next_cursor; unbounded boards over 1,000 pins are rejected instead of returning silent partial data. Pin media includes video_url when recovered plus explicit media_type and media_detection evidence.

- Platform: [Pinterest](https://docs.upscrape.com/docs/platforms/pinterest)
- Capability ID: `pinterest.board-full.get`
- Cost: 1 credit per request
- Maximum runtime: 120 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "max_pins": 25,
    "max_sections": 0,
    "page_size": 25,
    "url": "https://www.pinterest.com/PinterestPredicts/gimme-gummy/"
  },
  "capability": "pinterest.board-full.get"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `max_pins` | `integer` | No | Maximum total number of pins to return across board-level pins and section pins. Omit or set to 0 to fetch all available pins. |
| `max_sections` | `integer` | No | Maximum number of sections to scrape. When set, only the first N sections will have their pins fetched. Section metadata is always returned for all sections via stats.total_sections. Omit or set to 0 to scrape all sections. |
| `page_size` | `integer` | No | Pinterest pagination page size for full-board pin fetching. Board pin requests are capped at 250 and section pin requests at 50. |
| `url` | `string` | Yes | Full Pinterest board URL or ?boardId= URL |

### Example input

```json
{
  "max_pins": 25,
  "max_sections": 0,
  "page_size": 25,
  "url": "https://www.pinterest.com/PinterestPredicts/gimme-gummy/"
}
```

## Response

Successful output is returned in `results[0].data`. Raw platform output is intentionally open-ended and may evolve with the upstream source.

No committed sample output is available for this capability.


## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)

POST /execute Shared execution endpoint

Input parameters

max_pins integer optional

Maximum total number of pins to return across board-level pins and section pins. Omit or set to 0 to fetch all available pins.

Example 100

max_sections integer optional

Maximum number of sections to scrape. When set, only the first N sections will have their pins fetched. Section metadata is always returned for all sections via stats.total_sections. Omit or set to 0 to scrape all sections.

Example 20

page_size integer optional

Pinterest pagination page size for full-board pin fetching. Board pin requests are capped at 250 and section pin requests at 50.

Example 100

url string required

Full Pinterest board URL or ?boardId= URL

Example https://www.pinterest.com/pinterest/home-decor-ideas/

Response

Successful output is returned in results[0].data. Raw platform output is intentionally open-ended and may evolve with the upstream source.

No committed sample output is available for this capability yet.

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer YOUR_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "max_pins": 25, "max_sections": 0, "page_size": 25, "url": "https://www.pinterest.com/PinterestPredicts/gimme-gummy/" }, "capability": "pinterest.board-full.get" }'

import json import requests payload = json.loads(r'''{ "input": { "max_pins": 25, "max_sections": 0, "page_size": 25, "url": "https://www.pinterest.com/PinterestPredicts/gimme-gummy/" }, "capability": "pinterest.board-full.get" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))