notes

10 endpoints at a glance

Method	Path	Summary
GET	/notes	List Notes
POST	/notes	Create Note
DELETE	/notes/{note_id}	Delete Note
GET	/notes/{note_id}	Get Note
PATCH	/notes/{note_id}	Update Note
POST	/notes/{note_id}/links	Add Link
DELETE	/notes/{note_id}/purge	Purge Note
POST	/notes/{note_id}/restore	Restore Note
GET	/notes/for-entity	List For Entity
GET	/notes/trash	List Trash

notes

---

List Notes

GET

/notes

Notes in a notebook (defaults to Inbox), pinned first.

Parameters

Header Parameters

authorization

Query Parameters

notebook_id

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/notes

Playground

Headers

authorization

Variables

Key

Value

notebook_id

Samples

---

Create Note

POST

/notes

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"notebook_id": "string",

  

"title": "",

  

"body_md": "",

  

"tag_ids": [

  

  

"string"

  

],

  

"link_to": {

  

  

"additionalProperties": "string"

  

}

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/notes

Playground

Headers

authorization

Body

Samples

---

List Trash

GET

/notes/trash

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/notes/trash

Playground

Headers

authorization

Samples

---

List For Entity

GET

/notes/for-entity

Notes linked to one entity (any author the viewer can see).

Parameters

Header Parameters

authorization

Query Parameters

entity_type*

Type

string

Required

entity_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/notes/for-entity

Playground

Headers

authorization

Variables

Key

Value

entity_type*

entity_id*

Samples

---

Get Note

GET

/notes/{note_id}

Parameters

Header Parameters

authorization

Path Parameters

note_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/notes/{note_id}

Playground

Headers

authorization

Variables

Key

Value

note_id*

Samples

---

Delete Note

DELETE

/notes/{note_id}

Soft-delete (trash). Recoverable via POST /notes/{id}/restore.

Parameters

Header Parameters

authorization

Path Parameters

note_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/notes/{note_id}

Playground

Headers

authorization

Variables

Key

Value

note_id*

Samples

---

Update Note

PATCH

/notes/{note_id}

Parameters

Header Parameters

authorization

Path Parameters

note_id*

Type

string

Required

Request Body

application/json

{

  

"title": "string",

  

"body_md": "string",

  

"tag_ids": [

  

  

"string"

  

],

  

"pinned": true,

  

"notebook_id": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/notes/{note_id}

Playground

Headers

authorization

Variables

Key

Value

note_id*

Body

Samples

---

Restore Note

POST

/notes/{note_id}/restore

Parameters

Header Parameters

authorization

Path Parameters

note_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/notes/{note_id}/restore

Playground

Headers

authorization

Variables

Key

Value

note_id*

Samples

---

Purge Note

DELETE

/notes/{note_id}/purge

Permanently delete a trashed note + its links.

Parameters

Header Parameters

authorization

Path Parameters

note_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/notes/{note_id}/purge

Playground

Headers

authorization

Variables

Key

Value

note_id*

Samples

---

Add Link

POST

/notes/{note_id}/links

Link a note to an entity (the viewer must be able to read both).

Parameters

Header Parameters

authorization

Path Parameters

note_id*

Type

string

Required

Request Body

application/json

{

  

"type": "string",

  

"id": "string",

  

"ref": {

  

  

"additionalProperties": "string"

  

}

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/notes/{note_id}/links

Playground

Headers

authorization

Variables

Key

Value

note_id*

Body

Samples

---