Pinterest API Capability

Get User Boards

Fetches all public boards for a Pinterest user. Returns board metadata including name, description, pin count, section count, privacy setting, cover image, and owner information.

Capability ID pinterest.user-boards.get

Cost 1 credit per request

Maximum runtime 60 seconds

View raw

# Get User Boards

Fetches all public boards for a Pinterest user. Returns board metadata including name, description, pin count, section count, privacy setting, cover image, and owner information.

- Platform: [Pinterest](https://docs.upscrape.com/docs/platforms/pinterest)
- Capability ID: `pinterest.user-boards.get`
- Cost: 1 credit per request
- Maximum runtime: 60 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/"
  },
  "capability": "pinterest.user-boards.get"
}'
```

## Input

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

### Example input

```json
{
  "url": "https://www.pinterest.com/PinterestPredicts/"
}
```

## 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
{
  "boards": [
    {
      "collaborator_count": 2,
      "created_at": "Mon, 22 Sep 2025 19:19:42 +0000",
      "description": "The motto for 2026? Live, laugh, leaf. It’s crunch time, baby.",
      "follower_count": 239969,
      "has_custom_cover": true,
      "id": "871517034080951175",
      "image_cover_hd_url": "https://i.pinimg.com/474x/90/9b/8b/909b8be39e2348288b8c5d1d83f74c97.jpg",
      "image_cover_url": "https://i.pinimg.com/custom_covers/200x150/871517034080951175_1764016421.jpg",
      "is_collaborative": true,
      "name": "Cabbage Crush",
      "node_id": "Qm9hcmQ6ODcxNTE3MDM0MDgwOTUxMTc1",
      "owner": {
        "follower_count": 291542,
        "full_name": "Pinterest Predicts",
        "id": "871517102799028482",
        "image_medium_url": "https://i.pinimg.com/75x75_RS/1c/b5/61/1cb561c8e7b9c709f78d110a4b5f0863.jpg",
        "is_partner": true,
        "node_id": "VXNlcjo4NzE1MTcxMDI3OTkwMjg0ODI=",
        "username": "PinterestPredicts",
        "verified_identity": {
          "verified": true
        }
      },
      "pin_count": 126,
      "privacy": "public",
      "section_count": 0,
      "url": "/pinterestpredicts/cabbage-crush/"
    },
    {
      "collaborator_count": 2,
      "created_at": "Mon, 22 Sep 2025 18:36:43 +0000",
      "description": "This icy hue brings subzero sophistication to makeup, fashion and the frostiest of cocktails.",
      "follower_count": 240491,
      "has_custom_cover": true,
      "id": "871517034080951130",
      "image_cover_hd_url": "https://i.pinimg.com/474x/19/a3/e3/19a3e30754e9dd362d32494b161c5685.jpg",
      "image_cover_url": "https://i.pinimg.com/custom_covers/200x150/871517034080951130_1764023523.jpg",
      "is_collaborative": true,
      "name": "Cool Blue",
      "node_id": "Qm9hcmQ6ODcxNTE3MDM0MDgwOTUxMTMw",
      "owner": {
        "follower_count": 291542,
        "full_name": "Pinterest Predicts",
        "id": "871517102799028482",
        "image_medium_url": "https://i.pinimg.com/75x75_RS/1c/b5/61/1cb561c8e7b9c709f78d110a4b5f0863.jpg",
        "is_partner": true,
        "node_id": "VXNlcjo4NzE1MTcxMDI3OTkwMjg0ODI=",
        "username": "PinterestPredicts",
        "verified_identity": {
          "verified": true
        }
      },
      "pin_count": 199,
      "privacy": "public",
      "section_count": 0,
      "url": "/pinterestpredicts/cool-blue/"
    },
    {
      "collaborator_count": 1,
      "created_at": "Wed, 20 Aug 2025 15:11:08 +0000",
      "description": "Enter: the opulent party. Dial up the drama with velvet drapery, red roses and string quartets.",
      "follower_count": 240647,
      "has_custom_cover": true,
      "id": "871517034080906069",
      "image_cover_hd_url": "https://i.pinimg.com/474x/bf/80/ef/bf80ef001ff39dcedeca5615449a624e.jpg",
      "image_cover_url": "https://i.pinimg.com/custom_covers/200x150/871517034080906069_1766897613.jpg",
      "is_collaborative": true,
      "name": "Opera Aesthetic",
      "node_id": "Qm9hcmQ6ODcxNTE3MDM0MDgwOTA2MDY5",
      "owner": {
        "follower_count": 291542,
        "full_name": "Pinterest Predicts",
        "id": "871517102799028482",
        "image_medium_url": "https://i.pinimg.com/75x75_RS/1c/b5/61/1cb561c8e7b9c709f78d110a4b5f0863.jpg",
        "is_partner": true,
        "node_id": "VXNlcjo4NzE1MTcxMDI3OTkwMjg0ODI=",
        "username": "PinterestPredicts",
        "verified_identity": {
          "verified": true
        }
      },
      "pin_count": 228,
      "privacy": "public",
      "section_count": 0,
      "url": "/pinterestpredicts/opera-aesthetic/"
    }
  ]
}
```
### Illustrative output fields

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

| Path | Observed type | Example |
| --- | --- | --- |
| `boards` | `array` | 3 items |
| `boards` | `array` | 3 items |

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

Example https://www.pinterest.com/pinterest/

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
`boards`	`array`	3 items
`boards`	`array`	3 items

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/" }, "capability": "pinterest.user-boards.get" }'

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

{ "boards": [ { "collaborator_count": 2, "created_at": "Mon, 22 Sep 2025 19:19:42 +0000", "description": "The motto for 2026? Live, laugh, leaf. It’s crunch time, baby.", "follower_count": 239969, "has_custom_cover": true, "id": "871517034080951175", "image_cover_hd_url": "https://i.pinimg.com/474x/90/9b/8b/909b8be39e2348288b8c5d1d83f74c97.jpg", "image_cover_url": "https://i.pinimg.com/custom_covers/200x150/871517034080951175_1764016421.jpg", "is_collaborative": true, "name": "Cabbage Crush", "node_id": "Qm9hcmQ6ODcxNTE3MDM0MDgwOTUxMTc1", "owner": { "follower_count": 291542, "full_name": "Pinterest Predicts", "id": "871517102799028482", "image_medium_url": "https://i.pinimg.com/75x75_RS/1c/b5/61/1cb561c8e7b9c709f78d110a4b5f0863.jpg", "is_partner": true, "node_id": "VXNlcjo4NzE1MTcxMDI3OTkwMjg0ODI=", "username": "PinterestPredicts", "verified_identity": { "verified": true } }, "pin_count": 126, "privacy": "public", "section_count": 0, "url": "/pinterestpredicts/cabbage-crush/" }, { "collaborator_count": 2, "created_at": "Mon, 22 Sep 2025 18:36:43 +0000", "description": "This icy hue brings subzero sophistication to makeup, fashion and the frostiest of cocktails.", "follower_count": 240491, "has_custom_cover": true, "id": "871517034080951130", "image_cover_hd_url": "https://i.pinimg.com/474x/19/a3/e3/19a3e30754e9dd362d32494b161c5685.jpg", "image_cover_url": "https://i.pinimg.com/custom_covers/200x150/871517034080951130_1764023523.jpg", "is_collaborative": true, "name": "Cool Blue", "node_id": "Qm9hcmQ6ODcxNTE3MDM0MDgwOTUxMTMw", "owner": { "follower_count": 291542, "full_name": "Pinterest Predicts", "id": "871517102799028482", "image_medium_url": "https://i.pinimg.com/75x75_RS/1c/b5/61/1cb561c8e7b9c709f78d110a4b5f0863.jpg", "is_partner": true, "node_id": "VXNlcjo4NzE1MTcxMDI3OTkwMjg0ODI=", "username": "PinterestPredicts", "verified_identity": { "verified": true } }, "pin_count": 199, "privacy": "public", "section_count": 0, "url": "/pinterestpredicts/cool-blue/" }, { "collaborator_count": 1, "created_at": "Wed, 20 Aug 2025 15:11:08 +0000", "description": "Enter: the opulent party. Dial up the drama with velvet drapery, red roses and string quartets.", "follower_count": 240647, "has_custom_cover": true, "id": "871517034080906069", "image_cover_hd_url": "https://i.pinimg.com/474x/bf/80/ef/bf80ef001ff39dcedeca5615449a624e.jpg", "image_cover_url": "https://i.pinimg.com/custom_covers/200x150/871517034080906069_1766897613.jpg", "is_collaborative": true, "name": "Opera Aesthetic", "node_id": "Qm9hcmQ6ODcxNTE3MDM0MDgwOTA2MDY5", "owner": { "follower_count": 291542, "full_name": "Pinterest Predicts", "id": "871517102799028482", "image_medium_url": "https://i.pinimg.com/75x75_RS/1c/b5/61/1cb561c8e7b9c709f78d110a4b5f0863.jpg", "is_partner": true, "node_id": "VXNlcjo4NzE1MTcxMDI3OTkwMjg0ODI=", "username": "PinterestPredicts", "verified_identity": { "verified": true } }, "pin_count": 228, "privacy": "public", "section_count": 0, "url": "/pinterestpredicts/opera-aesthetic/" } ] }