SLslite

Search notes

Changed on

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

Request

  • Base URL
    https://api.slite.com/v1
  • Auth
    HTTP bearer

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

lastEditedAfterstring date-time

Optional filter to only return notes edited after a specific date, as ISO 8601

lastUpdatedAfterstring date-time

Optional filter to only return notes where metadata has changed after a specific date, as ISO 8601

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

Changes

  • 45539bfbc96dRevision changes
    • info

      for the query request parameter lastEditedAfter, the type was generalized from no type to string, and format from no format to date-time

    • info

      for the query request parameter lastUpdatedAfter, the type was generalized from no type to string, and format from no format to date-time

  • bf91106381fdRevision changes
    • info

      the security scope read was added to the endpoint's security scheme bearer