Get search results
Execute a search query across multiple workspace entities, including boards, cards, pages, and projects. Customize the search by specifying targeted fields like title or content, filtering by types of objects, or focusing on specific statuses. Additional options include filtering by project, controlling whether archived data is included, and choosing grouped or ungrouped results. This comprehensive search endpoint provides flexibility to locate relevant workspace data efficiently.
Authorizations
Path Parameters
Query Parameters
How results are matched and ranked. Defaults to bm25.
-
bm25: keyword search. Results match the query's words and are ranked byhow well they match.
-
semantic: results are ranked by closeness in meaning to the query, sothey need not contain its words. Each result carries a
score. Results below a fixed minimum similarity to the query are not returned, so a query with nothing close to it returns no results. A page or note'sexcerptis the passage that matched best.fieldsand thehighlightparameters do not apply, so titles and excerpts carry no highlight markup.countis the number of results on the page rather than a total, because every document is ranked and there is no set of matches to count. The query is limited to 1000 characters. Pagination works as inbm25mode, to the same depth, and stops once results fall below that minimum. -
hybrid: combines the two rankings, so results either contain the query'swords or are close to it in meaning, and a result both find ranks highest. A result found by its words is highlighted as in
bm25mode; one found only by meaning has no highlights, and a page or note'sexcerptis the passage that matched best.scoreis set when the result is close in meaning to the query and null when it was found only by its words.countis the number of results on the page, the query is limited to 1000 characters, and pagination works as inbm25mode, to the same depth. A query that is an id or a card or page reference is answered as inbm25mode.
A mode the workspace cannot serve is rejected with a 400. modes on the
response lists the ones it can.
bm25, semantic, hybrid Response
Search results