v1
latestOpenAPI 3.1.02026-08-04177151.5 KBpage
List Pages
Returns a list of pages for a site.
get/v6/pages
Query parameters
siteIdstring uuid required
The site ID to list pages from.
limitnumber double
The maximum number of pages to return.
startingAfterstring uuid
The pagination cursor. This is used to indicate what ID to list from.
pathPrefixstring
The filter that limits pages to only those with a pathname that begins with this value.
sortBy'title' | 'path' | 'description' | 'updatedAt' | 'createdAt'
The field to sort pages by.
sortDirection'asc' | 'desc'
The sort direction.
includeOffline'true' | 'false'
The flag that determines whether to include offline pages in the results.
localestring
The locale code to filter pages by.
versionRef'ref:live' | 'ref:draft'
The version reference to retrieve pages from. Defaults to ref:draft if not provided.
Supported formats:
- ref:draft - Draft/working version
- ref:live - Live/published version
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)