Notes API
Create and manage personal and project-level notes.
3 min read
Notes API
Create and manage notes within your project. Notes support markdown content and can be used for personal reference, team documentation, or project planning.
List Notes
GET /api/v1/notes?search={query}&limit=50
Retrieve notes for the current project, optionally filtered by a search query.
Query Parameters
searchstring
Full-text search across note titles and content.
limitnumber
Maximum number of notes to return (max: 200).
Response
dataNote[]
Array of note objects.
data[].idstring
Unique note identifier.
data[].titlestring
Note title.
data[].previewstring
Truncated preview of the note content (first 200 characters).
data[].createdAtnumber
Unix timestamp (ms) when the note was created.
data[].updatedAtnumber
Unix timestamp (ms) of the last update.
Get Note
GET /api/v1/notes/{id}
Retrieve the full note including its complete content.
Path Parameters
idstringrequired
The note ID.
Response
data.idstring
Unique note identifier.
data.titlestring
Note title.
data.contentstring
Full note content in markdown format.
data.createdAtnumber
Unix timestamp (ms) when the note was created.
data.updatedAtnumber
Unix timestamp (ms) of the last update.
Create Note
POST /api/v1/notes
Create a new note in the project.
Request Body
titlestringrequired
The note title.
contentstring
Note content in markdown format.
Response
data.idstring
The ID of the newly created note.
data.titlestring
The note title.
data.createdAtnumber
Creation timestamp (ms).
Update Note
PATCH /api/v1/notes/{id}
Update an existing note. Only the provided fields are changed.
Path Parameters
idstringrequired
The note ID.
Request Body
titlestring
Updated note title.
contentstring
Updated note content in markdown format.
Tip
Notes support full markdown syntax including headings, tables, code blocks, and links. Use them for meeting notes, content briefs, or tracking ideas that don't fit neatly into the entity system.
Was this helpful?