Skip to content

Notes API

All endpoints require authentication. Base path: /api/v1/notes.

MethodPathDescription
GET/v1/notesList notes
POST/v1/notesCreate a note (title, content, category_id, tags[])
GET/v1/notes/{note}Get a single note
PUT/v1/notes/{note}Update a note (incl. is_favorite, is_starred)
DELETE/v1/notes/{note}Delete a note
GET/v1/notes/newestNewest notes
MethodPathDescription
GET/v1/notes/categoriesList categories
POST/v1/notes/categoriesCreate a category (title, parent_id — hierarchical)
GET/v1/notes/categories/{category}Get a category
PUT/v1/notes/categories/{category}Update a category
DELETE/v1/notes/categories/{category}Delete a category

Categories support nesting via parent_id, so folders can contain subfolders.

MethodPathDescription
POST/v1/notes/importImport notes from a Markdown (.md) or ZIP (.zip) file (multipart)
GET/v1/notes/exportExport notes (full data export is via the Export system)