Skip to documentation
Browse documentation

Get Full Board

Fetches complete board data including all pins and sections. IMPORTANT: 'pins' contains board-level pins NOT in any section. Section-specific pins are nested inside 'sections[].pins'. This separation preserves the exact board organization. Also returns summary statistics.

Capability ID pinterest.board-full.get
Cost 1 credit per request
Maximum runtime 120 seconds
View raw Get an API key

POST /execute Shared execution endpoint

Input parameters

FieldTypeRequiredDescription
cookies object Optional Optional cookies for authenticated requests
max_pins integer Optional Maximum total number of pins to return across board-level pins and section pins. Omit or set to 0 to fetch all available pins.
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.
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.
url string Required Full Pinterest board URL or ?boardId= 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