Skip to main content

Read Published Page Layout

GET 
/v1/:slug/boards/:token/page_layout

Returns the stored design document for a board's published page: its uuid, the template it renders with, its slots, and subboards_settings.

slots and subboards_settings come back verbatim. They are raw JSON documents whose keys are camelCase (elementType, sectionColumns, collectionToken), and every id in them is the handle the write endpoints accept back — rewriting them would make this response disagree with what you have to send.

slots: null is normal, and this endpoint will not fix it for you​

A page's document is not stored until someone saves in the Publish editor. Until then the page still renders — the public site falls back to the template's shipped defaults — so a live, visible page can legitimately report "slots": null here. This endpoint reports that honestly: it is a read, so it takes no lock, writes nothing, and never invents a document.

To bootstrap such a page, address a slot by NAME. Send "slot_id": "menu" (the slot names for each template are in GET /v1/page_layout_elements under templates) to any write endpoint. The server materializes the template's defaults as part of that write and the response hands you back the slot with real ids for every element, which is what every subsequent call should address by.

Freshness​

This endpoint is immediately current: it reflects a write the moment the write returns. The public page at /s/<slug> is only eventually current — a write purges the cached render, but edge points of presence can keep serving a recent copy for up to an hour.

Requires the read scope. Not gated by the page-layout write flag.

Request​

Responses​

a page whose document has never been stored