Search notes

get

https://api.slite.com/v1/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.

Query Params

query

string

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

parentNoteId

string

Optional filter to only return notes under this parent note id

depth

double

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

reviewState

string

enum

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

Allowed:

page

int32

≥ 0

Used to perform pagination on search

hitsPerPage

int32

1 to 100

Specify how many notes to return per page

highlightPreTag

string

Inject a tag before the matching query

highlightPostTag

string

Inject a tag after the matching query

lastEditedAfter

string

Optional filter to only return notes edited after a specific date

lastUpdatedAfter

string

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

includeArchived

boolean

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

Responses

200Ok

401Invalid authentication

422Input validation error

429Rate limitation error

defaultUnexpected error