Search for a page

POST

/web-pages/page/pages/_search

Required scope: webpage:read

Searches for a page and returns information about it including variable values, if the page is found.

Parameters

countryCode string

Country code of the page. This or contentLocaleId must be provided.

languageCode string

Language code (in ISO 639-1 format) of the page. This or contentLocaleId must be provided.

contentLocaleId string

The content locale of the page. This or countryCode and languageCode combination must be provided.

categoryId string

ID of a category. This or path must be provided.

path string

URL path for this page. This or categoryId must be provided.

The page and its variable values.

Error code	Description
`web-pages.search-page.category-id-and-path-are-mutually-exclusive`	Category ID and path are mutually exclusive.
`web-pages.search-page.category-id-or-path-required`	Either category ID or path must be provided.
`web-pages.search-page.category-tree-not-found`	Could not find the category tree for the web store.
`web-pages.search-page.content-locale-id-is-exclusive-with-country-code-and-language-code`	Content locale ID is exclusive with country code and language code.
`web-pages.search-page.content-locale-id-or-country-code-and-language-code-required`	Either content locale ID, or both country code and language code must be provided.
`web-pages.search-page.language-code-invalid`	Specified language code is invalid.
`web-pages.search-page.locale-not-found`	Could not find the locale by ID or by country code and language code combination.
`web-pages.search-page.page-not-found`	Could not find the page by path.