Skip to documentation
Docs
Sign in Get an API key API key
Browse documentation
For AI agents

Connect your agent to live platform data.

Open in
Pinterest API Capability

Get full board

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

Capability ID pinterest.board-full.get
Maximum runtime 120 seconds
View raw

POST /execute Shared execution endpoint

Input parameters

collection_mode boolean optional

Return the records-v1 collection envelope for managed collection.

cursor string optional

Opaque pagination.next_cursor from the previous response. Keep the same URL and section selection.

max_pins integer optional

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.

Example 25
max_sections integer optional

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.

Example 20
page_size integer optional

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`.

Example 100
url string required

Full Pinterest board URL or ?boardId= 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 example response is shown in the response panel.

Illustrative output fields

Values illustrate one response. Read the guidance above for missing values and limits; fields can vary with the requested operation and the data available.

PathObserved typeExample
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.