Pinterest API Capability

Get Board Info

Fetches board metadata without pins. Returns board name, description, pin count, section count, owner, privacy setting, cover images, and section list with pin counts.

Capability ID pinterest.board-info.get

Cost 1 credit per request

Maximum runtime 45 seconds

View raw

# Get Board Info

Fetches board metadata without pins. Returns board name, description, pin count, section count, owner, privacy setting, cover images, and section list with pin counts.

- Platform: [Pinterest](https://docs.upscrape.com/docs/platforms/pinterest)
- Capability ID: `pinterest.board-info.get`
- 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": {
    "url": "https://www.pinterest.com/PinterestPredicts/gimme-gummy/"
  },
  "capability": "pinterest.board-info.get"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | `string` | Yes | Full Pinterest board URL |

### Example input

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

### Illustrative sample output

This redacted fixture is an example, not a fixed response schema.

```json
{
  "board": {
    "collaborator_count": 0,
    "description": "Bendy phone cases, rubberized nail art and 3D jewelry will become your new tactile obsession.",
    "follower_count": 0,
    "id": "871517034080907898",
    "is_collaborative": false,
    "name": "Gimme Gummy",
    "owner": {
      "full_name": "Pinterest Predicts",
      "id": "871517102799028482",
      "username": "pinterestpredicts"
    },
    "pin_count": 145,
    "privacy": "public",
    "section_count": 0,
    "url": "/pinterestpredicts/gimme-gummy/"
  }
}
```
### Illustrative output fields

Derived from the sample above for orientation only. These fields are not a fixed response schema.

| Path | Observed type | Example |
| --- | --- | --- |
| `board` | `object` | 11 fields |
| `board.collaborator_count` | `integer` | 0 |
| `board.description` | `string` | Bendy phone cases, rubberized nail art and 3D jewelry will become your … |
| `board.follower_count` | `integer` | 0 |
| `board.id` | `string` | 871517034080907898 |
| `board.is_collaborative` | `boolean` | false |
| `board.name` | `string` | Gimme Gummy |
| `board.owner` | `object` | 3 fields |
| `board.pin_count` | `integer` | 145 |
| `board.privacy` | `string` | public |
| `board.section_count` | `integer` | 0 |
| `board.url` | `string` | /pinterestpredicts/gimme-gummy/ |

## 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

url string required

Full Pinterest board 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.

Illustrative sample The full redacted fixture is shown in the response panel.

Illustrative output fields

Derived from the sample above for orientation only. These observed fields are not a fixed response schema.

Path	Observed type	Example
`board`	`object`	11 fields
`board.collaborator_count`	`integer`	0
`board.description`	`string`	Bendy phone cases, rubberized nail art and 3D jewelry will become your …
`board.follower_count`	`integer`	0
`board.id`	`string`	871517034080907898
`board.is_collaborative`	`boolean`	false
`board.name`	`string`	Gimme Gummy
`board.owner`	`object`	3 fields
`board.pin_count`	`integer`	145
`board.privacy`	`string`	public
`board.section_count`	`integer`	0
`board.url`	`string`	/pinterestpredicts/gimme-gummy/

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": { "url": "https://www.pinterest.com/PinterestPredicts/gimme-gummy/" }, "capability": "pinterest.board-info.get" }'

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

{ "board": { "collaborator_count": 0, "description": "Bendy phone cases, rubberized nail art and 3D jewelry will become your new tactile obsession.", "follower_count": 0, "id": "871517034080907898", "is_collaborative": false, "name": "Gimme Gummy", "owner": { "full_name": "Pinterest Predicts", "id": "871517102799028482", "username": "pinterestpredicts" }, "pin_count": 145, "privacy": "public", "section_count": 0, "url": "/pinterestpredicts/gimme-gummy/" } }