Skip to content

List Notes

GET
/api/v1/notes
curl --request GET \
--url https://example.com/api/v1/notes \
--header 'Authorization: Bearer <token>'

Requires a signed-in User with the data scope. Repeated tag values require all selected Tags and include nested Tags. It returns Notes that match the query and a cursor for the next page. It returns 400 when the query is invalid. Route: /api/v1/notes. Inputs: sort, cursor, limit, recent, tag, path. Safe reads can use bounded retries.

sort
string
cursor
string
limit
integer format: int64
recent
boolean
tag
Array<string>

Repeat tag to require every selected Tag and its nested Tags (#1109).

path
string
Media typeapplication/json
object
items
required
Array<object>
object
created
string | null
edited
string | null
id
required
string
path
required
string
title
required
string
next_cursor
string | null
Examplegenerated
{
"items": [
{
"created": "example",
"edited": "example",
"id": "example",
"path": "example",
"title": "example"
}
],
"next_cursor": "example"
}