Generate experiences with Puck AI
Read docs
CloudAPI referencecloud-clientServer APIspages.list

pages.list

Puck Pages is experimental and may change in a future release.

List all pages.

await puck.pages.list();
// { results: [{ id: "page_123", path: "/about", version: 3, publishedVersion: 2, status: "draft", createdAt: "2026-10-30T12:00:00.000Z", createdBy: "user_123" }], count: 1, hasMore: false }

Returns a PageList containing the pages, and pagination data.

Args

ParamExampleTypeStatus
params{ offset: 100 }Object-
options{ auth: {} }Object-

params

Which pages to list. Defaults to the first 100.

ParamExampleTypeStatus
offsetoffset: 100Number-
limitlimit: 50Number-

offset

How many pages to skip. Defaults to 0.

const { results } = await puck.pages.list({ offset: 100 });

limit

How many pages to return, up to 100. Defaults to 100.

const { results } = await puck.pages.list({ limit: 50 });

options

Set the request options for this call.