Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring sites

Get a page by unique id.

Returns the page metadata specified by unique page-id. This API is equalivent to /sites/pages/{site-id/pages{page-id} but does not require a site-id.

If the page is a root page then no parentId will be returned in the response. <br />User roles: admin, manager, editor, viewer

get/authoring/v1/sites/pages/{page-id}

Path parameters

page-idstring uuid required

ID of page.

Query parameters

fieldsstring

Reduce the returned page metadata down to just the specified fields. Fields specified by a comma seperated list of field names and should only be used once in query string. To only retrieve rev and lastModified this parameter should look like fields=rev,lastModified.

includestring

Specify additional fields to include with each result. The following fields can be specified to be included in the page item: 'hierarchicalPath', 'route'. You can specify multiple fields as a comma-separated value. For example, include=hierarchicalPath,route. The hierarchicalPath field is a concatenation of each ancestor page name field and the route field is a concatenation of each ancestor page segment field.

Response

succcess.

idstring

The ID of the page item.

revstring

The current revision of the document.

namestring

The name of the page item.

contentIdstring

The ID of the page content item this item represents.

contentTypeIdstring

The ID of the page content type.

positionstring

Position relative to sibling pages giving the order of the pages. Position is an integer value starting at 0.

descriptionstring

Page description.

layoutIdstring

Page layout template ID.

segmentstring

Friendly URL segment.

titlestring

Page title.

parentIdstring

Not present if root page otherwise id of parent page

classificationstring

This is always page

lastModifiedstring

The last modified date of this page in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.

lastModifierIdstring

This is the user id of the user that modified the page. This field is read only

createdstring

The creation date of this page in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only

creatorIdstring

This is the user id of the user that created the page. This field is read only.

hideFromNavigationboolean

This controls the visibility of the page in the site navigation menu. If set to true this page is hidden. If set to true on a parent page, it will override the corresponding flags in all descendant pages. Therefore, hiding a page will hide all its descendants in the site navigation menu.