Get All Notes

Purpose

This API is used to retrieve the details of all the notes added in a group or all personal notes added by you.

OAuth Scope

Use the scope

ZohoMail.notes.ALL (or) ZohoMail.notes.READ

to generate the Authtoken.

ALL - Grants full access to notes.

READ - Grants access to read notes.

Request URL

Method: GET

Group Notes:

https://mail.zoho.com/api/notes/groups/{groupId}

or

Personal Notes:

https://mail.zoho.com/api/notes/me

Path Parameters

  • groupId* long
    • Specifies the unique ID of the group.
    • This parameter can be retrieved from the Get all groups API.

Query Parameters

  • fields string (comma-separated list)
    • This parameter specifies the details associated with the note that you wish to retrieve. 
    • Allowed values: 
      • title string
        • This parameter specifies the title of the note.
      • content string
        • This parameter specifies the content of the note.
      • color int
        • This parameter specifies the color code of the note.
      • bookId long
        • This parameter specifies the ID of the book with which the notes are associated to. 
      • bookName string
        • This parameter specifies the name of the book with which the notes are associated to. 
    • Example: fields=title,content,color
    • If no field is entered, all the details will be retrieved.
  • after int
    • This parameter specifies from which retrieval has to be done.
    • Allowed values : 1 to (Number of Notes)
  • limit int
    • This parameter specifies the number of notes to retrieve.
    • Allowed values : 1 to 399.
    • Default value : 25.
  • isPrev boolean
    • This parameter specifies whether the retrieval should be in ascending or descending order based on created time.
    • Allowed values : 
      • true - To retrieve in ascending order.
      • false - To retrieve in descending  order.
    • Default value : false.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request - For Group Notes

Copiedcurl "https://mail.zoho.com/api/notes/groups/84626808?limit=2" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

Sample Request - For Personal Notes

Copiedcurl "https://mail.zoho.com/api/notes/me?limit=2" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

Sample Success Response

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "pagination": {
      "next": "https://mail.zoho.com/api/notes/groups/845623755?after=2&limit=2"
    },
    "list": [
      {
        "modifiedTime": "1712039510042",
        "color": "-1",
        "namespaceId": "845623755",
        "entityId": "1712039510042180001",
        "title": "Title",
        "colorHex": "#c6f5f9",
        "bookName": "General",
        "content": "13",
        "isFavorite": "false",
        "bookId": "6573686000000008005"
      },
      {
        "modifiedTime": "1712039505545",
        "color": "-1",
        "namespaceId": "845623755",
        "entityId": "1712039505544180001",
        "title": "Title",
        "colorHex": "#ffffff",
        "bookName": "General",
        "content": "12",
        "isFavorite": "false",
        "bookId": "6573686000000008005"
      }
    ]
  }
}

Sample Failure Response

Copied{
  "data": {
    "errorCode": "PATTERN_NOT_MATCHED",
    "moreInfo": "fields Input does not match the given pattern"
  },
  "status": {
    "code": 400,
    "description": "Invalid Input"
  }
}