/api/v1/searchSearch everything
Fuzzy search over everything you can open: titles, headings, the text of pages and documents, the text of HTML files and PDFs, folders, workspaces, the Guides pages you have a role on and, at the end, your Trash. Typos, partial words and any word order match. items is the ranked page of results; groups holds the first few of each kind, for a grouped list; trash lists matching items you can restore. Each result has its kind, title, workspace, folder, owner (named only when you're related to the item), updated_at, a snippet with the matched words' ranges in marks, match (title, heading or body), url (what the app opens) and web_url (always a full link). Encrypted and password-protected items match by title only and never have a snippet. Pass next_cursor back as cursor for more. ai_suggested is true when q reads like a question.
Guide: Search
Code samples and Try itQuery parameters
#qstringWhat to look for. Up to 200 characters. Default
"".scopestringall(the default) orworkspace:<workspace id>for one workspace. Up to 40 characters.kindstringComma-separated kinds:
page,doc,file,folder,workspace,guide. Up to 80 characters.ownerstringmekeeps only your own items. One ofanyone,me. One ofanyone,me. Default"anyone".updatedstringweekormonthkeeps only what changed in that time. One ofany,week,month. One ofany,week,month. Default"any".currentstringThe id of the workspace you're in: its items rank a little higher. Up to 40 characters.
cursorstringThe
next_cursorof the previous answer. Up to 200 characters.limitintegerResults per answer, up to 50. From 1 to 50. Default
20.trashbooleanfalseleaves out the Trash matches. Defaulttrue.
Responses
#200OK.401No token, or the token is revoked or mistyped.422The request didn't validate.detaillists each problem, with where it is (loc) and why (msg).429Too many requests from your IP address. Wait the seconds inRetry-After.