Search notes and lists
Find the notes and lists of a vault's Knowledge holding every word given.
A note or a list is found when each word is in its title, its text, its description or any of its cells. Case and accents are ignored as the language of the account ignores them, a word is found at the start of a longer one, and one typing mistake is tolerated from five letters, two from nine.
This endpoint also answers QUERY, with the same parameters sent in the request body. How QUERY works.
Parameters
Sent as JSON. Anything not listed here is ignored.
The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.
The words to find, at least two characters and up to 255.
Returns
The notes and the lists found, or an empty list. A vault of another account answers 404.
Every note found, then every list found, whole rather than a page at a time.
One knowledge note, or one knowledge list as the knowledge lists endpoints describe it, told apart by type.
knowledge_note or knowledge_list.
The id of the note or the list.
Everything the note holds, or what the list is without its columns and items.
The title of the note.
The folder the note sits in.
The id of the folder, as the knowledge folders endpoints give it.
What the folder is called.
When the note was written, as a count of seconds since 1970.
When it last changed, as a count of seconds, or null.
The text of the note in Markdown, exactly as written, or null. It is never drawn: raw HTML in it stays text, and the application escapes it when it shows the note.
The headings of the text, from the first level to the third, in reading order.
One heading.
What the heading says.
Its level, 1 to 3.
The anchor the application gives it, to open the note at that heading with links.web followed by # and the anchor.
For a list, what it is for, in Markdown as written, or null. A note carries none.
Where to find this note or list.
The absolute address it is read from.
The note or the list in the application.
Rate limit
Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.
Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.