v1

latestOpenAPI 3.1.02026-08-04177151.5 KB

page

Get Page

Returns a page by its ID or pathname.

get/v6/pages/{pageIdOrPathname}

Path parameters

pageIdOrPathnamestring required

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

Query parameters

siteIdstring uuid

The site ID required when using a pathname instead of a page ID.

versionRef'ref:live' | '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

localestring

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.

Headers

x-api-keystring required

API key authentication. Accepts either:

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

Response

object'page' required

idstring uuid required

The ID of the page.

pathnamestring required

The page pathname.

canonicalUrlstring nullable required

The canonical URL of the page.

titlestring nullable required

The page title.

descriptionstring nullable required

The page description.

socialImageUrlstring nullable required

The social image URL of the page.

sitemapPrioritynumber double nullable required

The sitemap priority.

The sitemap update frequency.

createdAtstring date-time nullable required

The page creation date and time.

updatedAtstring date-time nullable required

The page last update date and time.

publishedAtstring date-time nullable required

The page publication date and time.

isOnlineboolean required

The flag that indicates whether the page is online.

excludedFromSearchEnginesboolean nullable required

The flag that indicates whether the page is excluded from search.

localestring

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