Sitecore API catalog/Pages API/
/
Search for pages

Search for pages

Request

Fetches a list of pages and folders whose name or display name match the search criteria, while applying filters and language options.

Security
Bearer
Query
searchTextstring

The text by which to search for the name or display name.

Example:searchText=Home
rootIdsArray of strings

If you want to limit the search to pages or folders under a specific parent, the list of identifiers to search under.

Example:rootIds=758852c6488045cca3947d83ff2f56e7&rootIds=888852c6488045cca3947d83ff2f56e7&rootIds=758852c6488045cca3947d83ff2f56e7&rootIds=888852c6488045cca39
filterstring, (int32)(TypeFilter)

The search filter. Possible values are "Pages" (items that have a presentation layout and can be rendered), "Folders" (items that use 'folder' as their base template), "All" (both pages and folders).

Enum:"Pages""Folders""All"
Example:filter="Pages"
languagestring

If you want to limit the search to items in a specific language, the language code of those items.

Example:language=en
pageSizeinteger, (int32), [ 0 .. 2147483647 ]

The page size of the results to return.

Example:pageSize=10
pageNumberinteger, (int32), [ 0 .. 2147483647 ]

The page number used to paginate the results.

Example:pageNumber=1
continuationTokenstring

Continuation token for pagination.

environmentIdstring

The identifier of the environment.

curl -i -X GET \
  'https://xmapps-api.sitecorecloud.io/api/v1/pages/search?searchText=Home&rootIds=758852c6488045cca3947d83ff2f56e7%2C888852c6488045cca3947d83ff2f56e7&filter=%22Pages%22&language=en&pageSize=10&pageNumber=1&continuationToken=string&environmentId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
totalCountinteger, (int32)

The total number of pages found by the search. Example value: 25

Example:25
resultsArray of objects or null(Page)

The collection of result pages returned by the search.

Response
{
  "totalCount": 25,
  "results": [
    { … }
  ]
}