Pinterest API Capability

List Board Pins

Returns one bounded page of public board pins plus pagination.next_cursor. Keep requesting with cursor until pagination.has_more is false. Designed for large-board backups and resumable collection.

Capability ID pinterest.board-pins.list

Cost 1 credit per request

Maximum runtime 45 seconds

View raw

# List Board Pins

Returns one bounded page of public board pins plus pagination.next_cursor. Keep requesting with cursor until pagination.has_more is false. Designed for large-board backups and resumable collection.

- Platform: [Pinterest](https://docs.upscrape.com/docs/platforms/pinterest)
- Capability ID: `pinterest.board-pins.list`
- Cost: 1 credit per request
- Maximum runtime: 45 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": {
    "limit": 25,
    "url": "https://www.pinterest.com/PinterestPredicts/gimme-gummy/"
  },
  "capability": "pinterest.board-pins.list"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `cursor` | `string` | No | Opaque continuation cursor returned by the previous page |
| `limit` | `integer` | No | Maximum pins returned in this page |
| `url` | `string` | Yes | Full public Pinterest board URL |

### Example input

```json
{
  "limit": 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

cursor string optional

Opaque continuation cursor returned by the previous page

limit integer optional

Maximum pins returned in this page

Example 25

url string required

Full public Pinterest board URL

Example 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 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": { "limit": 25, "url": "https://www.pinterest.com/PinterestPredicts/gimme-gummy/" }, "capability": "pinterest.board-pins.list" }'

import json import requests payload = json.loads(r'''{ "input": { "limit": 25, "url": "https://www.pinterest.com/PinterestPredicts/gimme-gummy/" }, "capability": "pinterest.board-pins.list" }''') 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))