Sign in

v3

latestOpenAPI 3.0.0private2026-07-31264964.3 KB

Search notes

Search notes based on a query. The scope of the notes is restricted to the authenticated user. Various optional filters are available to restrict the scope of the search even more.

get/search-notes

Query parameters

querystring

Query used to perform the note search, default to empty string

parentNoteIdstring

Optional filter to only return notes under this parent note id

depthnumber double

Optional filter to only return notes with a depth (number of parents) equal to a specified value

reviewState'Verified' | 'Outdated' | 'VerificationRequested' | 'VerificationExpired'

Optional filter to return notes in a special review state Can be Verified, Outdated, VerificationRequested or VerificationExpired

pageinteger

Used to perform pagination on search

hitsPerPageinteger

Specify how many notes to return per page

highlightPreTagstring

Inject a tag before the matching query

highlightPostTagstring

Inject a tag after the matching query

{"stackTrail":"paths:/search-notes:get:parameters:8:schema","oasType":"schema","type":"unknown"}

Optional filter to only return notes edited after a specific date

{"stackTrail":"paths:/search-notes:get:parameters:9:schema","oasType":"schema","type":"unknown"}

Optional filter to only return notes where metadata has changed after a specific date

includeArchivedboolean

Optional filter to also include archived notes in the search results (default to false)

Response

Ok

nbPagesnumber double required

Total number of pages for the current query

pagenumber double required

Current page number of the search pagination