Skip to navigation

Get Page Metadata

Get metadata information for a single page.

Required scope | pages:read

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

page_idstringRequiredformat: "objectid"
Unique identifier for a Page

Query parameters

localeIdstringOptional

Unique identifier for a specific Locale.

Learn more about localization.

translatablestringOptional

Unique identifier for the secondary Locale you're translating into. Returns only content that hasn't been excluded from translation for that locale.

This is independent of localeId, which selects which version of the content is returned. To fetch the source text to translate, request the primary locale's content and set translatable to the locale you're translating into:

?localeId={primary locale id}&translatable={target locale id}

Only exclusion rules scoped to manual translation are respected — rules scoped only to automatic translation don't affect this parameter's response.

Omitting translatable returns the same response as if this parameter didn't exist. The value must be the id of one of the site's secondary locales — the primary locale id, or any other value, returns a 400 error. Requires translation exclusions to be enabled for the site; if they aren't, the request returns a 403 error.

Learn more about localization.

Response

Request was successful
idstringformat: "objectid"
Unique identifier for the Page
siteIdstringOptionalRead-onlyformat: "objectid"
Unique identifier for the Site
titlestringOptional
Title of the Page
slugstringOptional

slug of the Page (derived from title)

parentIdstringOptionalRead-onlyformat: "objectid"
Identifier of the parent folder
collectionIdstringOptionalRead-onlyformat: "objectid"
Unique identifier for a linked Collection, value will be null if the Page is not part of a Collection.
createdOnstringOptionalRead-onlyformat: "date-time"
The date the Page was created
lastUpdatedstringOptionalRead-onlyformat: "date-time"
The date the Page was most recently updated
archivedbooleanOptionalRead-onlyDefaults to false
Whether the Page has been archived
draftbooleanOptionalRead-onlyDefaults to false
Whether the Page is a draft
canBranchbooleanOptionalRead-onlyDefaults to false

Indicates whether the Page supports Page Branching. Pages that are already branches cannot be branched again.

isBranchbooleanOptionalRead-onlyDefaults to false

Indicates whether the Page is a Branch of another Page Page Branching

branchIdstring or nullOptionalformat: "objectid"
If the Page is a Branch of another Page, this is the ID of the Branch
seoobjectOptional

SEO-related fields for the Page

openGraphobjectOptional
Open Graph fields for the Page
localeIdstring or nullOptionalRead-onlyformat: "objectid"
Unique ID of the page locale
publishedPathstringOptionalRead-only
Relative path of the published page URL

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error