3. Notebooks

3.1. Get Notebooks

Endpoint: /notebooks/notebooks
Method: GET
Request header: Authorization: Bearer <access_token>
Description: Get the list of notebooks of the user that makes the request
Response data:
Field Type
message string
message_type string
result
list of objects
- id: string
- name: string
- tag_colors: object (optional)
- tag1: string
- ...
- tagN: string
- created: string
- last_modified: string
Request example:
curl -X 'GET' '{{ host_url }}notebooks/notebooks' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <access_token>'

3.2. Get Notebook

Endpoint: /notebooks/notebook/<notebook_id>
Method: GET
Request header: Authorization: Bearer <access_token>
Description: Get a notebook
Response data:
Field Type
message string
message_type string
result
object
- id: string
- name: string
- tag_colors: object (optional)
- tag1: string
- ...
- tagN: string
- created: string
- last_modified: string
Request example:
curl -X 'GET' '{{ host_url }}notebooks/notebook/<notebook_id>' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <access_token>'

3.3. Create Notebook

Endpoint: /notebooks/notebook
Methods: POST, PUT
Request header: Authorization: Bearer <access_token>
Description: Create a notebook
Request data:
Field Type Required
name string Yes
tag_colors
object
- tag1: string
- ...
- tagN: string
 No
Response data:
Field Type
message string
message_type string
result
object
- notebook_id: string
Request example:
curl -X 'POST' '{{ host_url }}notebooks/notebook' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <access_token>' \
-d '{"name": "Example Notebook", "tag_colors": {"tag1": "#00ff00", "tag2": "#0000ff"}}'

3.4. Update Notebook

Endpoint: /notebooks/notebook/<notebook_id>
Method: PUT
Request header: Authorization: Bearer <access_token>
Description: Update some or all fields of a notebook
Request data:
Field Type Required
name string Yes
tag_colors
object
- tag1: string
- ...
- tagN: string
 No
Response data:
Field Type
message string
message_type string
Request example:
curl -X 'PUT' '{{ host_url }}notebooks/notebook/<notebook_id>' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <access_token>' \
-d '{"name": "Example Notebook", "tag_colors": {"tag1": "#00ff00", "tag2": "#0000ff"}}'

3.5. Delete Notebook

Endpoint: /notebooks/notebook/<notebook_id>
Method: DELETE
Request header: Authorization: Bearer <access_token>
Description: Delete a notebook
Response data:
Field Type
message string
message_type string
Request example:
curl -X 'DELETE' '{{ host_url }}notebooks/notebook/<notebook_id>' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <access_token>'