It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Full text Search API for documents

Hi Folks i want to know does Confluence API support or provide results for full text data ie. content of  documents. I can see for blogs and pages we can retrieve the body, but not sure is it possible for uploaded word or pdf documents.




1 answer

1 accepted

0 votes
Answer accepted
Daniel Eads Atlassian Team Feb 24, 2020

Hey Raj,

Welcome to the Community! You can indeed use the API to search the text of documents for indexable content (Word, Text, PowerPoint, Excel, PDF, and HTML). The mechanism for searching via API is CQL - here are the documents on all the available search operators.

The text parameter includes the contents of attachments. For example, if I've got a text attachment that contains the word "potato", this search will return it: ~ "potato"


For completeness (although you're asking about Cloud), I'll mention that Confluence Server would use the contentBody parameter for searching instead of the text parameter. Just a slight difference to note for anyone else finding this via Google search and looking for Server help.

Hope that helps!


Suggest an answer

Log in or Sign up to answer
Community showcase
Posted in Confluence

Lessons and Learnings: Six Months of Working Remote [Discussion]

Hey there, folks! For most of us, the past six months- yes, you read that right- have been a journey. More people than ever before have pivoted to working remotely, and navigating being on-scre...

4,120 views 4 6
Join discussion

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you