Search for Pages

Learn how to find specific pages through search, using HAPI.

You can search for page using HAPI by entering CQL or a title search.

Search for pages using the title

Searching for a massive page list that could be unlimited could lead to using a lot of memory. We recommend searching for a specific number:

For example, the top 10:
1
Pages.search('title = Overview').take(10)
The results show the following information for each page titled Overview.
You can customize this search by replacing the title.
Warning: DO NOT attempt to convert a potentially unlimited set to a List, like:
Pages.search('title = Overview').toList()
If you need a list of results, limit it to a specific number like 100.
The following script finds the top 100 results for that title and adds the label review.
1
Pages.search('title = Overview').take(100).toList().each { it.addLabels("review") }
Once this script is run, a label is added to the found pages. You can now see the label in the results:
And you can see the label on the page:
You can customize this script by changing the title, number of results, and the label.
Tip: You can filter results further with another condition:
Pages.search('title = FOO').findAll { // condition }

To search for a space in Confluence, enter a script like this:

Pages.search('valid CQL here').each {
     // do something with it
 }

The results of the search are page IDs in the result:

You can customize this script by changing the CQL.