Skip to navigation

List Pages

List of all pages for a site.

This endpoint supports:

  • filter[title][contains] queries: case-insensitive, literal substring matching on the page title, with a 1–256 character value. For example, filter[title][contains]=about.

Required scope | pages:read

Authentication

AuthorizationBearer

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

Path parameters

site_idstringRequiredformat: "objectid"
Unique identifier for a Site

Query parameters

localeIdstringOptional

Unique identifier for a specific Locale.

Learn more about localization.

limitintegerOptional

Maximum number of records to be returned (max limit: 100)

offsetintegerOptional
Offset used for pagination if the results have more than limit records
filterobjectOptional

Filter pages by title using bracket notation: filter[title][contains]=<value>.

Example: filter[title][contains]=about.

contains is case-insensitive and matches literal substrings; regular expressions and wildcards are not supported. The value must be 1–256 characters. When localeId is provided, the match uses that locale’s title, falling back to the page’s default title when the locale has no localized title.

Response

Request was successful
pageslist of objectsOptional
paginationobjectOptional
Pagination object

Errors

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