Get the full page hierarchy for a site.

get

https://example.com/authoring/v1/sites/{site-id}/pages

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.

User roles: admin, manager, editor, viewer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

site-id

uuid

required

The ID of the site.

Query Params

fields

string of strings

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.

include

string

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.

responseFormat

string

Defaults to hierarchical

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

Responses

200succcess.

400Bad request

401Unauthorized

403Forbidden

404Not found

429Too Many Requests

defaultUnexpected error