v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring sites

Get the full page hierarchy for a site.

Use this endpoint to retrieve the full page hierarchy for site. The metadata for each page will be included. This metadata includes the position of the page relative to its peers, the ID for the page content item, an optional override layout ID to use and encoded route if query parameter included=route is specified. <br />User roles: admin, manager, editor, viewer

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

Path parameters

site-idstring uuid required

The ID of the site.

Query parameters

fieldsstring

Reduce the returned page metadata down to just the specified fields in the returned page hierarchy. 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.

responseFormatstring

Specify the format for the response. Valid values are 'hierarchical' and 'list'. Default is 'hierarchical'.

Response

succcess.