Skip to content

Notes

Get notes

Section titled “ Get notes ”
GET v3/projects/23423233/notebooks/41246749/notes returns all notes in the specified notebook. 
[
  {
    "id": 80731707,
    "title": "Requirements for launch party",
    "private": false,
    "assigned": [12009183],
    "comments": 0
  },
  {
    "id": 80731708,
    "title": "Launch of the New Website",
    "private": false,
    "assigned": [12009183],
    "comments": 0
  }
]

Get note

Section titled “ Get note ”
GET v3/projects/23423233/notebooks/41246749/notes/80731708 returns the specified note. 
{
  "id": 80731708,
  "title": "Launch of the New Website",
  "content": "A post on our Blog ...",
  "private": false,
  "assigned": [12009183]
}

Create note

Section titled “ Create note ”
POST v3/projects/23423233/notebooks/41246749/notes creates a new note. 
{
  "title": "Requirements",
  "description": "Requirements for designing",
  "content": "Mention all that will be required for designing a LOGO for the client.",
  "private": true,
  "assigned": [12009183, 11679192]
}

The assigned array is optional and accepts people IDs.

201 Created is returned along with the created note.

Update note

Section titled “ Update note ”
PUT v3/projects/23423233/notebooks/41246749/notes/80731709 updates an existing note. 
{
  "title": "Requirements",
  "description": "Requirements for designing the LOGO",
  "content": "Mention all that will be required for designing a LOGO for the client.",
  "private": false
}
200 OK is returned along with the updated note.

Delete note

Section titled “ Delete note ”
PUT v3/projects/23423233/notebooks/41246749/notes/80731708 deletes the specified note.
204 No Content is returned if the note is deleted successfully.

Get all note comments

Section titled “ Get all note comments ”
GET v3/projects/23423233/notebooks/41246749/notes/80731708/comments returns all comments for the specified note. 
[
  {
    "id": 36215469,
    "description": "Design of website completed",
    "status": "open"
  },
  {
    "id": 36215467,
    "description": "Content updated",
    "status": "open"
  }
]

Get comment

Section titled “ Get comment ”
GET v3/projects/23423233/notebooks/41246749/notes/80731708/comments/36215469 returns the specified comment. 
{
  "id": 36215469,
  "description": "Design of website completed",
  "status": "open"
}

Create comment

Section titled “ Create comment ”
POST v3/projects/23423233/notebooks/41246749/notes/13966758232/comments creates a new comment. 
{
  "description": "Meeting with the client"
}

Update comment

Section titled “ Update comment ”
PUT v3/projects/23423233/notebooks/41246749/notes/13966758232/comments/30438075 updates a comment. 
{
  "description": "Call with client"
}

Delete comment

Section titled “ Delete comment ”
DELETE v3/projects/23423233/notebooks/41246749/notes/13966758232/comments/30438075 deletes the specified comment.
204 No Content is returned if the comment is deleted successfully.

Resolve comment

Section titled “ Resolve comment ”

Changes the status of a comment to resolved. 

{
  "status": "resolved"
}

Re-open comment

Section titled “ Re-open comment ”

Changes the status of a resolved comment back to open. 

{
  "status": "open"
}
All comment update, resolve, and reopen operations return 200 OK when successful and 204 No Content when access is denied.