Skip to navigation
RESTPages

Get Page

Returns a page by its ID or pathname.

Authentication

x-api-keystring

API key authentication. Accepts either:

  • App API key (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ)
  • Site API key (UUID format, e.g. 550e8400-e29b-41d4-a716-446655440000)

Path parameters

pageIdOrPathnamestringRequired
The page ID or pathname for the page you are requesting.

Query parameters

siteIdstringOptionalformat: "uuid"
The site ID required when using a pathname instead of a page ID.
versionRefenumOptionalDefaults to ref:draft

The version reference to retrieve the page from. Defaults to ref:draft if not provided.

Supported formats:

  • ref:draft - Draft/working version
  • ref:live - Live/published version
Allowed values:
localestringOptional

The locale to retrieve the page in. Accepts either a locale code (e.g. en-US) or a site_locale UUID. If provided and resolves to a non-default locale, localized page data is collapsed into the response.

includeenumOptional

Include additional data in the response. Omit for the page record alone.

Supported values:

  • elements - include the page’s element tree. This feature is in beta and may change. Requests return 403 until the feature flag is enabled for your site or workspace.
Allowed values:

Response

objectenum
Allowed values:
idstringformat: "uuid"
The ID of the page.
pathnamestring
The page pathname.
canonicalUrlstring or null
The canonical URL of the page.
titlestring or null
The page title.
descriptionstring or null
The page description.
socialImageUrlstring or null
The social image URL of the page.
sitemapPrioritydouble or null0-1
The sitemap priority.
sitemapFrequencyenum or null
The sitemap update frequency.
createdAtdatetime or null
The page creation date and time.
updatedAtdatetime or null
The page last update date and time.
publishedAtdatetime or null
The page publication date and time.
isOnlineboolean
The flag that indicates whether the page is online.
excludedFromSearchEnginesboolean or null
The flag that indicates whether the page is excluded from search.
localizationslist of objects
The localizations of the page.
elementsobject or null

The root of the page’s element tree. null unless include=elements.

localestringOptional
The page locale. This defaults to the default locale of the parent site.

Errors

403
Forbidden Error