Generate experiences with Puck AI
Read docs
CloudAPI referencecloud-clientTypesPage

Page

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

A page at one of its versions.

{
  "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"
}

Params

ParamExampleTypeStatus
idid: "page_123"StringRequired
pathpath: "/about"StringRequired
datadata: { root: {}, content: [] }DataRequired
versionversion: 3NumberRequired
publishedVersionpublishedVersion: 2Number | nullRequired
statusstatus: "draft""published" | "draft"Required
createdAtcreatedAt: "2026-10-30T12:00:00.000Z"StringRequired
createdBycreatedBy: "user_123"String | nullRequired

id

The page’s id.

path

The page’s path.

data

This version’s data.

version

This version’s number. It starts at 1 and increases by 1 with each save.

publishedVersion

The number of the published version, or null if the page is not published.

status

"published" if this version is the published version, otherwise "draft".

createdAt

When this version was saved, as an ISO timestamp.

createdBy

The id of the user who saved this version. This is your user from auth.identity, or a Puck user. null if an API key saved the version without naming a user.