pages.getByPath
Puck Pages is experimental and may change in a future release.
Get the page at a path.
await puck.pages.getByPath("/about");
// { id: "page_123", path: "/about", data: { root: { props: {} }, content: [] }, version: 3, publishedVersion: 2, status: "draft", createdAt: "2026-10-30T12:00:00.000Z", createdBy: "user_123" }Returns the Page, or null if the page or version doesn’t exist.
Args
| Param | Example | Type | Status |
|---|---|---|---|
path | "/about" | String | Required |
version | 2 | Number | - |
options | { auth: {} } | Object | - |
path
The page’s path.
version
The version’s number. Defaults to the latest version.
const page = await puck.pages.getByPath("/about", 2);options
Set the request options for this call.