# Get full board

Collect public board pins and section memberships in resumable chunks of up to 1,000 pins, with explicit completeness.

- 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 $UPSCRAPE_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 |
| --- | --- | --- | --- |
| `collection_mode` | `boolean` | No | Return the records-v1 collection envelope for managed collection. |
| `cursor` | `string` | No | Opaque pagination.next_cursor from the previous response. Keep the same URL and section selection. |
| `max_pins` | `integer` | No | Optional pin bound for this response. Each response returns at most 1,000 pins; follow pagination.next_cursor while has_more is true. Zero uses the default chunk bound. At least 0. |
| `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. At least 0. |
| `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. From 1 to 250. Default: `250`. |
| `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.

### Illustrative sample output

This example shows one response. Values and optional fields vary with the data available.

```json
{
  "board": {
    "id": "64950488315410023",
    "is_collaborative": false,
    "pin_count": 29,
    "privacy": "public",
    "section_count": 1,
    "url": "/ashishbishnoi18/myboard/"
  },
  "outcome": {
    "reason": "pagination_exhausted",
    "status": "complete"
  },
  "pagination": {
    "has_more": false,
    "retrieved_total": 29
  },
  "pins": [
    {
      "board": {
        "id": "64950488315410023",
        "is_collaborative": false,
        "pin_count": 0,
        "privacy": "public",
        "section_count": 0,
        "url": "/ashishbishnoi18/myboard/"
      },
      "favorite_count": 0,
      "has_products": false,
      "id": "64950419623552899",
      "images": {
        "170x": {
          "height": 314,
          "url": "https://i.pinimg.com/236x/7a/3d/6f/7a3d6fe5e27487bec562003b28bae116.jpg",
          "width": 236
        },
        "236x": {
          "height": 314,
          "url": "https://i.pinimg.com/236x/7a/3d/6f/7a3d6fe5e27487bec562003b28bae116.jpg",
          "width": 236
        },
        "474x": {
          "height": 632,
          "url": "https://i.pinimg.com/474x/7a/3d/6f/7a3d6fe5e27487bec562003b28bae116.jpg",
          "width": 474
        },
        "736x": {
          "height": 981,
          "url": "https://i.pinimg.com/736x/7a/3d/6f/7a3d6fe5e27487bec562003b28bae116.jpg",
          "width": 736
        },
        "orig": {
          "height": 1920,
          "url": "https://i.pinimg.com/originals/7a/3d/6f/7a3d6fe5e27487bec562003b28bae116.jpg",
          "width": 1440
        }
      },
      "is_native": false,
      "is_promoted": false,
      "is_repin": true,
      "is_story_pin": false,
      "is_video": false,
      "media_detection": "unverified",
      "media_type": "unknown",
      "repin_count": 0,
      "save_count": 4361
    },
    {
      "board": {
        "id": "64950488315410023",
        "is_collaborative": false,
        "pin_count": 0,
        "privacy": "public",
        "section_count": 0,
        "url": "/ashishbishnoi18/myboard/"
      },
      "favorite_count": 0,
      "has_products": false,
      "id": "64950419623552896",
      "images": {
        "170x": {
          "height": 222,
          "url": "https://i.pinimg.com/236x/73/53/76/735376d42bb60653356c1143d348e648.jpg",
          "width": 236
        },
        "236x": {
          "height": 222,
          "url": "https://i.pinimg.com/236x/73/53/76/735376d42bb60653356c1143d348e648.jpg",
          "width": 236
        },
        "474x": {
          "height": 446,
          "url": "https://i.pinimg.com/474x/73/53/76/735376d42bb60653356c1143d348e648.jpg",
          "width": 474
        },
        "736x": {
          "height": 692,
          "url": "https://i.pinimg.com/736x/73/53/76/735376d42bb60653356c1143d348e648.jpg",
          "width": 736
        },
        "orig": {
          "height": 1057,
          "url": "https://i.pinimg.com/originals/73/53/76/735376d42bb60653356c1143d348e648.jpg",
          "width": 1123
        }
      },
      "is_native": false,
      "is_promoted": false,
      "is_repin": true,
      "is_story_pin": false,
      "is_video": false,
      "media_detection": "unverified",
      "media_type": "unknown",
      "repin_count": 0,
      "save_count": 4027
    },
    {
      "board": {
        "id": "64950488315410023",
        "is_collaborative": false,
        "pin_count": 0,
        "privacy": "public",
        "section_count": 0,
        "url": "/ashishbishnoi18/myboard/"
      },
      "favorite_count": 0,
      "has_products": false,
      "id": "64950419623570137",
      "images": {
        "170x": {
          "height": 419,
          "url": "https://i.pinimg.com/236x/b4/97/d7/b497d7481031fdcb8083110704840a12.jpg",
          "width": 236
        },
        "236x": {
          "height": 419,
          "url": "https://i.pinimg.com/236x/b4/97/d7/b497d7481031fdcb8083110704840a12.jpg",
          "width": 236
        },
        "474x": {
          "height": 842,
          "url": "https://i.pinimg.com/474x/b4/97/d7/b497d7481031fdcb8083110704840a12.jpg",
          "width": 474
        },
        "736x": {
          "height": 1280,
          "url": "https://i.pinimg.com/736x/b4/97/d7/b497d7481031fdcb8083110704840a12.jpg",
          "width": 720
        },
        "orig": {
          "height": 1280,
          "url": "https://i.pinimg.com/originals/b4/97/d7/b497d7481031fdcb8083110704840a12.jpg",
          "width": 720
        }
      },
      "is_native": false,
      "is_promoted": false,
      "is_repin": true,
      "is_story_pin": true,
      "is_video": true,
      "media_detection": "confirmed",
      "media_type": "video",
      "page_count": 1,
      "repin_count": 1540,
      "save_count": 12224,
      "video_url": "https://v1.pinimg.com/videos/iht/720p/c2/e9/34/c2e93432144b58f72de5ca2857095f4b.mp4"
    }
  ],
  "sections": [
    {
      "id": "5469010104714075890",
      "pin_count": 6,
      "pins": [
        {
          "board": {
            "id": "64950488315410023",
            "is_collaborative": false,
            "pin_count": 0,
            "privacy": "public",
            "section_count": 0,
            "url": "/ashishbishnoi18/myboard/"
          },
          "favorite_count": 0,
          "has_products": false,
          "id": "64950419623552970",
          "images": {
            "170x": {
              "height": 419,
              "url": "https://i.pinimg.com/236x/4a/ba/b4/4abab487c45905abb79fcc5abf3acac3.jpg",
              "width": 236
            },
            "236x": {
              "height": 419,
              "url": "https://i.pinimg.com/236x/4a/ba/b4/4abab487c45905abb79fcc5abf3acac3.jpg",
              "width": 236
            },
            "474x": {
              "height": 842,
              "url": "https://i.pinimg.com/474x/4a/ba/b4/4abab487c45905abb79fcc5abf3acac3.jpg",
              "width": 474
            },
            "736x": {
              "height": 1308,
              "url": "https://i.pinimg.com/736x/4a/ba/b4/4abab487c45905abb79fcc5abf3acac3.jpg",
              "width": 736
            },
            "orig": {
              "height": 1920,
              "url": "https://i.pinimg.com/originals/4a/ba/b4/4abab487c45905abb79fcc5abf3acac3.jpg",
              "width": 1080
            }
          },
          "is_native": false,
          "is_promoted": false,
          "is_repin": true,
          "is_story_pin": true,
          "is_video": true,
          "media_detection": "confirmed",
          "media_type": "video",
          "page_count": 1,
          "repin_count": 0,
          "save_count": 23571,
          "video_url": "https://v1.pinimg.com/videos/iht/720p/ae/bc/d2/aebcd2c0e48476eebf1a663db0dc5b8b.mp4"
        },
        {
          "board": {
            "id": "64950488315410023",
            "is_collaborative": false,
            "pin_count": 0,
            "privacy": "public",
            "section_count": 0,
            "url": "/ashishbishnoi18/myboard/"
          },
          "favorite_count": 0,
          "has_products": false,
          "id": "64950419623552909",
          "images": {
            "170x": {
              "height": 419,
              "url": "https://i.pinimg.com/236x/05/83/d0/0583d04b766b56116e58f6eec3607505.jpg",
              "width": 236
            },
            "236x": {
              "height": 419,
              "url": "https://i.pinimg.com/236x/05/83/d0/0583d04b766b56116e58f6eec3607505.jpg",
              "width": 236
            },
            "474x": {
              "height": 842,
              "url": "https://i.pinimg.com/474x/05/83/d0/0583d04b766b56116e58f6eec3607505.jpg",
              "width": 474
            },
            "736x": {
              "height": 1280,
              "url": "https://i.pinimg.com/736x/05/83/d0/0583d04b766b56116e58f6eec3607505.jpg",
              "width": 720
            },
            "orig": {
              "height": 1280,
              "url": "https://i.pinimg.com/originals/05/83/d0/0583d04b766b56116e58f6eec3607505.jpg",
              "width": 720
            }
          },
          "is_native": false,
          "is_promoted": false,
          "is_repin": true,
          "is_story_pin": true,
          "is_video": false,
          "media_detection": "unverified",
          "media_type": "unknown",
          "page_count": 1,
          "repin_count": 0,
          "save_count": 2
        },
        {
          "board": {
            "id": "64950488315410023",
            "is_collaborative": false,
            "pin_count": 0,
            "privacy": "public",
            "section_count": 0,
            "url": "/ashishbishnoi18/myboard/"
          },
          "favorite_count": 0,
          "has_products": false,
          "id": "64950419623552908",
          "images": {
            "170x": {
              "height": 419,
              "url": "https://i.pinimg.com/236x/14/31/7a/14317ae457ac9f50234dde0efa352404.jpg",
              "width": 236
            },
            "236x": {
              "height": 419,
              "url": "https://i.pinimg.com/236x/14/31/7a/14317ae457ac9f50234dde0efa352404.jpg",
              "width": 236
            },
            "474x": {
              "height": 842,
              "url": "https://i.pinimg.com/474x/14/31/7a/14317ae457ac9f50234dde0efa352404.jpg",
              "width": 474
            },
            "736x": {
              "height": 1308,
              "url": "https://i.pinimg.com/736x/14/31/7a/14317ae457ac9f50234dde0efa352404.jpg",
              "width": 736
            },
            "orig": {
              "height": 1920,
              "url": "https://i.pinimg.com/originals/14/31/7a/14317ae457ac9f50234dde0efa352404.jpg",
              "width": 1080
            }
          },
          "is_native": false,
          "is_promoted": false,
          "is_repin": true,
          "is_story_pin": false,
          "is_video": false,
          "media_detection": "unverified",
          "media_type": "unknown",
          "repin_count": 0,
          "save_count": 4
        }
      ]
    }
  ],
  "stats": {
    "board_pins": 23,
    "section_pins": 6,
    "sections_scraped": 1,
    "total_pins": 29,
    "total_sections": 1
  }
}
```
### 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` | 6 fields |
| `board.id` | `string` | 64950488315410023 |
| `board.is_collaborative` | `boolean` | false |
| `board.pin_count` | `integer` | 29 |
| `board.privacy` | `string` | public |
| `board.section_count` | `integer` | 1 |
| `board.url` | `string` | /ashishbishnoi18/myboard/ |
| `outcome` | `object` | 2 fields |
| `outcome.reason` | `string` | pagination_exhausted |
| `outcome.status` | `string` | complete |
| `pagination` | `object` | 2 fields |
| `pagination.has_more` | `boolean` | false |
| `pagination.retrieved_total` | `integer` | 29 |
| `pins` | `array` | 3 items |
| `pins` | `array` | 3 items |
| `sections` | `array` | 1 items |
| `sections` | `array` | 1 items |
| `stats` | `object` | 5 fields |
| `stats.board_pins` | `integer` | 23 |
| `stats.section_pins` | `integer` | 6 |
| `stats.sections_scraped` | `integer` | 1 |
| `stats.total_pins` | `integer` | 29 |
| `stats.total_sections` | `integer` | 1 |

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