Pinterest API Capability

Get Board ID

Extracts the numeric board ID from a Pinterest board URL. The board ID is required for some API operations and is extracted from the page's embedded data.

Capability ID pinterest.board-id.get

Cost 1 credit per request

Maximum runtime 30 seconds

View raw Get an API key

# Get Board ID

Extracts the numeric board ID from a Pinterest board URL. The board ID is required for some API operations and is extracted from the page's embedded data.

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

## Request

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

```bash
curl -X POST https://data.upscrape.com/execute \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":{"url":"https://www.pinterest.com/PinterestPredicts/gimme-gummy/"},"capability":"pinterest.board-id.get"}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `cookies` | `object` | No | Optional cookies for authenticated requests |
| `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.

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.

See [jobs and results](https://docs.upscrape.com/docs/api/jobs), [errors and retries](https://docs.upscrape.com/docs/api/errors), and [idempotency](https://docs.upscrape.com/docs/api/idempotency).

## Machine-readable contract

- [Capability OpenAPI 3.1](https://docs.upscrape.com/docs/platforms/pinterest/pinterest.board-id.get/openapi.json)
- [Platform OpenAPI 3.1](https://upscrape.com/scrapers/pinterest/openapi.json)
- [Focused coding-agent prompt](https://upscrape.com/scrapers/pinterest/capabilities/pinterest.board-id.get/llm.md)

POST /execute Shared execution endpoint

Input parameters

Field	Type	Required	Description
`cookies`	`object`	Optional	Optional cookies for authenticated requests
`url`	`string`	Required	Full Pinterest board URL

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.

Resources

OpenAPI 3.1 Markdown Platform OpenAPI

curl -X POST https://data.upscrape.com/execute \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"input":{"url":"https://www.pinterest.com/PinterestPredicts/gimme-gummy/"},"capability":"pinterest.board-id.get"}'

const response = await fetch("https://data.upscrape.com/execute", { method: "POST", headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", }, body: JSON.stringify({"input":{"url":"https://www.pinterest.com/PinterestPredicts/gimme-gummy/"},"capability":"pinterest.board-id.get"}), }); console.log(await response.json());

import requests response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", }, json={"input":{"url":"https://www.pinterest.com/PinterestPredicts/gimme-gummy/"},"capability":"pinterest.board-id.get"}, ) print(response.json())