For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Notes

Retrieve notes — a single note by UUID, or a filtered, paginated list. Supports full-text search with match snippets and a tree view that nests notes under their parent folders.

GET /v1/notes
GET /v1/notes/{uuid}

Query parameters

All parameters are optional.

Parameter
Type
Default
Description

uuid

string or string[]

Return only the note(s) with these UUIDs. Also settable as the path parameter.

case_uuid

string

Notes belonging to this case.

case_id

number

Notes belonging to this case (numeric id).

case_note_id

number

A note by its numeric id.

created_by_id

number

Notes authored by this user id.

updated_by_id

number

Notes last updated by this user id.

evidence_uuid

string

Notes linked to this evidence item.

object_id

string

Notes linked to this object (see Note Object Links).

is_folder

boolean

true returns only folders, false only notes.

include_content

boolean

false

Include the HTML body (note_data) and attachments in each result. Off by default to keep list responses small.

search

string

Full-text search on the note text. Matching notes include a snippets array of short excerpts around each match.

tree

boolean

false

Return notes nested under their parent folders via a children array instead of a flat list.

sort_by

string

One of created_on, updated_on, case_note_id, uuid, case_id, parent_id, is_folder, object_type, object_id.

sort_dir

string

asc

asc or desc.

page

number

1

Page number (1-based).

page_size

number

3000

Results per page, max 3000.

Boolean parameters accept true/false/1/0.

Response — 200 OK

Notes on the response shape:

  • note_data is only present when include_content=true. Image src attributes inside it are rewritten to short-lived signed URLs on every read — don't persist them; re-fetch the note when you need fresh links.

  • snippets is only present on search queries.

  • With tree=true, top-level items gain a children array containing their nested notes/folders.

Examples

Get a single note with its content

List all notes in a case

Search notes and print match snippets

Fetch a case's notes as a folder tree

Errors

Status
Body
Cause

400

{"message": "Invalid query parameters", "errors": [...]}

Bad parameter type or value (e.g. page=0, unknown sort_by).

401

Unauthorized

Missing or invalid API key.

Last updated

Was this helpful?