get_pages
Read pages, their revisions, or their publish status. Omit pageId to list website pages (including pages with no public route): default fields pageId, path, routed, liveUrl with truncated true; liveUrl is the absolute public URL for the primary locale, an empty path is the homepage, a dynamic path is filled from one sample entry, an unrouted page has routed false and no liveUrl; full=true adds pathsByLocale, objectTypeId, slugParamName, and displayLabel. Pass pageId to load one page: the response includes liveUrl, default mode=summary lists saved keys only after compact (truncated true), mode=full returns the stored tree, blockId with mode=full returns that block's tree, mode=detailed adds requests, mappings, and parse errors, mode=mapping returns ComponentBlock inputMappings, mode=translation-gaps returns per-locale overlay gaps. versions=N lists the page's revisions (newest first); revisionId returns one stored revision; publishStatus { path, revisionId } reports whether that revision is the one served for the path. A summary is not a write body. See design/shared-concepts/data-requests. Every response also carries style. The default is the contrast colours only (page background, surface, primary text, and inverse text), plus the dark palette when dual theme is on. includeStyle=true adds fonts, radius, section padding, the container width, and the breakpoints. Use them instead of get_theme; block props still take token paths such as colors.text.primary.
get_pages · Group: design
Read pages, their revisions, or their publish status. Omit pageId to list website pages (including pages with no public route): default fields pageId, path, routed, liveUrl with truncated true; liveUrl is the absolute public URL for the primary locale, an empty path is the homepage, a dynamic path is filled from one sample entry, an unrouted page has routed false and no liveUrl; full=true adds pathsByLocale, objectTypeId, slugParamName, and displayLabel. Pass pageId to load one page: the response includes liveUrl, default mode=summary lists saved keys only after compact (truncated true), mode=full returns the stored tree, blockId with mode=full returns that block's tree, mode=detailed adds requests, mappings, and parse errors, mode=mapping returns ComponentBlock inputMappings, mode=translation-gaps returns per-locale overlay gaps. versions=N lists the page's revisions (newest first); revisionId returns one stored revision; publishStatus { path, revisionId } reports whether that revision is the one served for the path. A summary is not a write body. See design/shared-concepts/data-requests. Every response also carries style. The default is the contrast colours only (page background, surface, primary text, and inverse text), plus the dark palette when dual theme is on. includeStyle=true adds fonts, radius, section padding, the container width, and the breakpoints. Use them instead of get_theme; block props still take token paths such as colors.text.primary.
Inputs
| Field | Required | Notes |
|---|---|---|
websiteId | required | |
pageId | optional | |
fields | optional | |
full | optional | |
versions | optional | List this many stored revisions instead. |
revisionId | optional | Return one stored revision instead. |
publishStatus | optional | { path, revisionId }: report whether that revision is served for the path. |
contentLocale | optional | |
mode | optional | summary (default) | full | detailed | mapping | translation-gaps. summary returns ids and saved keys. full returns the stored tree. |
blockId | optional | |
blockType | optional | Summary filter: block type. |
under | optional | Summary filter: this block and its descendants. |
depth | optional | Summary filter: max depth under the root, or under under. |
propsKeys | optional | Summary: false returns id and type only. |
includeDefaults | optional | true or annotate. Applies to mode=full. |
shape | optional | grouped (default) | legacy-flat |
previewEntryId | optional | Run the page's list and get requests against this entry and return preview.query timings. |
previewToken | optional | |
routeParams | optional | |
includeStyle | optional |
Maps to
GET /api/v1/{locale}/{websiteId}/pages→ APIGET /api/v1/{locale}/{websiteId}/pages/{pageId}→ APIPOST /api/v1/{locale}/{websiteId}/design/revisions→ APIGET /api/v1/{locale}/{websiteId}/design/publish-status→ API