API reference
Notes
Notes, notebooks and sharing.
Base URL https://api.pinal.tech/v1
API reference
Notes, notebooks and sharing.
Base URL https://api.pinal.tech/v1
/notesNotes, most recently edited first.
notebook string Notebook ID.
q string Full-text search.
limit integer Items per page, 1–100.
cursor string Opaque cursor from a previous page's next_cursor.
curl "https://api.pinal.tech/v1/notes" \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"notes": [
{
"id": "note_31d9aa",
"title": "string",
"content": "string",
"notebook": "string",
"pinned": true,
"created_at": "2026-11-19T15:20:04Z",
"updated_at": "2026-11-19T15:20:04Z"
}
],
"next_cursor": "string"
}/notesCreates a note in a notebook (the default one if omitted). Content is Markdown.
id string read-onlytitle string content string Markdown.
notebook string pinned boolean created_at string (date-time) read-onlyupdated_at string (date-time) read-onlycurl -X POST "https://api.pinal.tech/v1/notes" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"title": "Ideas",
"content": "- Sunrise hike\n- Picnic at Lost Dutchman"
}'{
"id": "note_31d9aa",
"title": "string",
"content": "string",
"notebook": "string",
"pinned": true,
"created_at": "2026-11-19T15:20:04Z",
"updated_at": "2026-11-19T15:20:04Z"
}/notes/{id}One note with its content.
id string requiredNote ID.
curl "https://api.pinal.tech/v1/notes/{id}" \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"id": "note_31d9aa",
"title": "string",
"content": "string",
"notebook": "string",
"pinned": true,
"created_at": "2026-11-19T15:20:04Z",
"updated_at": "2026-11-19T15:20:04Z"
}/notes/{id}Change the title, content or notebook.
id string requiredNote ID.
id string read-onlytitle string content string Markdown.
notebook string pinned boolean created_at string (date-time) read-onlyupdated_at string (date-time) read-onlycurl -X PATCH "https://api.pinal.tech/v1/notes/{id}" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"id": "note_31d9aa",
"title": "string",
"content": "string",
"notebook": "string",
"pinned": true,
"created_at": "2026-11-19T15:20:04Z",
"updated_at": "2026-11-19T15:20:04Z"
}'{
"id": "note_31d9aa",
"title": "string",
"content": "string",
"notebook": "string",
"pinned": true,
"created_at": "2026-11-19T15:20:04Z",
"updated_at": "2026-11-19T15:20:04Z"
}/notes/{id}Moves it to the trash for 30 days.
id string requiredNote ID.
curl -X DELETE "https://api.pinal.tech/v1/notes/{id}" \
-H "Authorization: Bearer $ACCESS_TOKEN"/notes/{id}/shareCreates a share link or invites people by email.
id string requiredNote ID.
invite array of string (email) link boolean access string One of view edit
curl -X POST "https://api.pinal.tech/v1/notes/{id}/share" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"invite": [
"alex@pinal.email"
],
"link": true,
"access": "view"
}'{
"url": "string",
"invited": [
"string"
]
}