notebooks

10 endpoints at a glance

Method	Path	Summary
GET	/notebooks	List Notebooks
POST	/notebooks	Create Notebook
DELETE	/notebooks/{notebook_id}	Delete Notebook
GET	/notebooks/{notebook_id}	Get Notebook
PATCH	/notebooks/{notebook_id}	Update Notebook
GET	/notebooks/{notebook_id}/members	List Members
POST	/notebooks/{notebook_id}/members	Add Member
DELETE	/notebooks/{notebook_id}/members/{member_username}	Remove Member
PATCH	/notebooks/{notebook_id}/members/{member_username}	Change Member Role
POST	/notebooks/reorder	Reorder Notebooks

notebooks

---

List Notebooks

GET

/notebooks

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/notebooks

Playground

Headers

authorization

Samples

---

Create Notebook

POST

/notebooks

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"name": "string",

  

"color": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/notebooks

Playground

Headers

authorization

Body

Samples

---

Reorder Notebooks

POST

/notebooks/reorder

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"ordered_ids": [

  

  

"string"

  

]

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/notebooks/reorder

Playground

Headers

authorization

Body

Samples

---

Get Notebook

GET

/notebooks/{notebook_id}

Parameters

Header Parameters

authorization

Path Parameters

notebook_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/notebooks/{notebook_id}

Playground

Headers

authorization

Variables

Key

Value

notebook_id*

Samples

---

Delete Notebook

DELETE

/notebooks/{notebook_id}

Delete a notebook and all its notes (not the Inbox).

Parameters

Header Parameters

authorization

Path Parameters

notebook_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/notebooks/{notebook_id}

Playground

Headers

authorization

Variables

Key

Value

notebook_id*

Samples

---

Update Notebook

PATCH

/notebooks/{notebook_id}

Parameters

Header Parameters

authorization

Path Parameters

notebook_id*

Type

string

Required

Request Body

application/json

{

  

"name": "string",

  

"color": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/notebooks/{notebook_id}

Playground

Headers

authorization

Variables

Key

Value

notebook_id*

Body

Samples

---

List Members

GET

/notebooks/{notebook_id}/members

Parameters

Header Parameters

authorization

Path Parameters

notebook_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/notebooks/{notebook_id}/members

Playground

Headers

authorization

Variables

Key

Value

notebook_id*

Samples

---

Add Member

POST

/notebooks/{notebook_id}/members

Parameters

Header Parameters

authorization

Path Parameters

notebook_id*

Type

string

Required

Request Body

application/json

{

  

"username": "string",

  

"role": "editor"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/notebooks/{notebook_id}/members

Playground

Headers

authorization

Variables

Key

Value

notebook_id*

Body

Samples

---

Remove Member

DELETE

/notebooks/{notebook_id}/members/{member_username}

Parameters

Header Parameters

authorization

Path Parameters

notebook_id*

Type

string

Required

member_username*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/notebooks/{notebook_id}/members/{member_username}

Playground

Headers

authorization

Variables

Key

Value

notebook_id*

member_username*

Samples

---

Change Member Role

PATCH

/notebooks/{notebook_id}/members/{member_username}

Parameters

Header Parameters

authorization

Path Parameters

notebook_id*

Type

string

Required

member_username*

Type

string

Required

Request Body

application/json

{

  

"role": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/notebooks/{notebook_id}/members/{member_username}

Playground

Headers

authorization

Variables

Key

Value

notebook_id*

member_username*

Body

Samples

---