Get All Favourite Notes

Purpose

This API is used to retrieve the details of all the favourite notes.

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

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

Path Parameters

  • zgid* long
    • Specifies the unique identifier used for groups in an organization.
    • 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
        • This parameter specifies the content of the note.
      • color
        • This parameter specifies the color code of the note.
      • bookId
        • This parameter specifies the ID of the book with which the notes are associated to. 
      • bookName
        • 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

Copiedcurl "https://mail.zoho.com/api/notes/favorites?after=2&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/favorites?after=2&limit=2"
    },
    "list": [
      {
        "modifiedTime": "1712041255079",
        "color": "-1",
        "namespaceId": "84626808",
        "entityId": "1712041255679110001",
        "title": "Title",
        "colorHex": "#c6f5f9",
        "bookName": "General",
        "content": "test",
        "isFavorite": "true",
        "bookId": "3764869000000005003"
      },
      {
        "modifiedTime": "1712038082184",
        "color": "-1",
        "namespaceId": "78762952",
        "entityId": "1712038082183110001",
        "title": "sss",
        "colorHex": "#fff8af",
        "bookName": "General",
        "content": "ss",
        "isFavorite": "true",
        "bookId": "3016198000000005005"
      }
    ]
  }
}

Sample Failure Response

Copied{
  "status": {
    "code": 500,
    "description": "Internal Error"
  },
  "data": {
    "moreInfo": "Invalid Input"
  }
}