---
title: "Search notes"
method: GET
path: "/search-notes"
---

# Search notes

`GET /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 parameters

- `query` string
- `parentNoteId` string
- `depth` number, double
- `reviewState` 'Verified' | 'Outdated' | 'VerificationRequested' | 'VerificationExpired'
- `page` integer
- `hitsPerPage` integer
- `highlightPreTag` string
- `highlightPostTag` string
- `lastEditedAfter` unknown
- `lastUpdatedAfter` unknown
- `includeArchived` boolean

## Response `200`

Ok

- SearchNoteResult
  - `hits` SearchNoteHit[], required
    - `parentNotes` object[], required — Breadcrumb of the note The first element is the channel
      - `title` string, required
      - `id` string, required
    - `reviewState` 'Verified' | 'Outdated' | 'VerificationRequested' | 'VerificationExpired'
    - `highlight` string, required — Part of the note that matched the query. If an empty string is returned, it means only the title matched.
    - `type` 'rich_text' | 'discussion' | 'collection', required
    - `archivedAt` string, date-time, nullable, required — Date of the archiving of the note (null if not archived)
    - `iconColor` string, nullable — Optional icon color for the note.
    - `iconShape` string, nullable — Optional icon identifier for the note.
    - `lastEditedAt` string, date-time, required — Date of the last edition of the note
    - `updatedAt` string, date-time, required — Date of the last update of the note
    - `title` string, required — Title of the note
    - `id` string, required — Id of the note
  - `nbPages` number, double, required — Total number of pages for the current query
  - `page` number, double, required — Current page number of the search pagination

## Other responses

- `401` — Invalid authentication
- `422` — Input validation error
- `429` — Rate limitation error
- `default` — Unexpected error

---

[API](https://skmtc.net/slite/apis/public-slite-api.md) · [All operations](https://skmtc.net/slite/apis/public-slite-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/slite/public-slite-api/versions/7cee1a5a5128/schema)