GET - All Notes in a Book

Purpose

This API is used to retrieve the details of all the notes in a Book.

Request URL 

Group Notes

https://mail.zoho.com/api/notes/groups/<groupid>/books/<bookId>

Personal Notes

https://mail.zoho.com/api/notes/me/books/<bookId>

Request Parameters

ParameterData TypeAllowed ValuesDescription
GroupID*Long The unique identifier used for groups in the organization
bookId*Integer The unique identifier used for each Book in Notes
limitInteger 

1 - 499

The number of notes that you would like to retrieve
afterInteger 1 - maximum number of notesThe note number from which the retrieval has to be done
fieldsString
  • title
  • content
  • color
  • bookName

(separated by comma)

The details associated with the note that you wish to retrieve.

Notes color code: 0 - blue, 1 - green, 2 - yellow, 3 - red

(If no field is entered, all the details will be retrieved.)

* - Mandatory parameters

Response Codes

Please refer Response Codes.

Group Notes

Sample Request


				https://mail.zoho.com/api/notes/groups/1726251/books/29000000034001?limit=6			

Sample response


				{
    "status": {
        "code": 200,
        "description": "success"
    },
    "data": {
        "list": [{
            "content": "Please look into the typos, correct them and update me with the new web document.",
            "title": "Comparison Document",
            "namespaceId": "1726251",
            "color": "3",
            "isFavorite": "true",
            "entityId": "36000000040005",
            "bookId": "36000000005001",
            "bookName": "Marketing"
        }, {
            "content": "Close support tickets 
            Complete blog post
            Finish competitor analysis
            Bulk purchase ",
            "title": "Checklist",
            "namespaceId": "1726251",
            "color": "2",
            "isFavorite": "true",
            "entityId": "36000000040003",
            "bookId": "36000000005001",
            "bookName": "Marketing"
        }, {
            "content": "There are a lot of stock images available in our website folder under the path /home/marketing/stock/nature",
            "title": "Marketing Stock Photos",
            "namespaceId": "1726251",
            "color": "4",
            "entityId": "27000000016001"
        }, {
            "content": "Hi Team, I am very much interested in the recent app that you have launched and want to purchase it for 25 users in my organization. Since it is a bulk purchase, I wanted to know if you can offer us any special discounts for the same.  Thanks, Anderson.",
            "title": "App Discounts",
            "namespaceId": "1726251",
            "color": "3",
            "entityId": "36000000008001"
        }, {
            "content": "Billboards
            Ads
            Target leads
            Email Campaigns ",
            "title": "Sales Improvement Ideas",
            "namespaceId": "1726251",
            "color": "2",
            "entityId": "36000000007001"
        }, {
            "content": "- Storage and plan details  - Free account accessibility - Docs storage - Workplace plans ",
            "title": "Comparison Page Must-Have",
            "namespaceId": "1726251",
            "color": "1",
            "entityId": "36000000006001"
        }]
    }
}			

Personal Notes

Sample Request


				https://mail.zoho.com/api/notes/me/books/29000000034001?limit=6			

Sample Response


				{
    "status": {
        "code": 200,
        "description": "success"
    },
    "data": {
        "list": [{
            "content": "Please look into the typos, correct them and update me with the new web document.",
            "title": "Comparison Document",
            "color": "3",
            "isFavorite": "true",
            "entityId": "36000000040005",
            "bookId": "36000000005001",
            "bookName": "Marketing"
        }, {
            "content": "Close support tickets 
            Complete blog post
            Finish competitor analysis
            Bulk purchase ",
            "title": "Checklist",
            "color": "2",
            "isFavorite": "true",
            "entityId": "36000000040003",
            "bookId": "36000000005001",
            "bookName": "Marketing"
        }, {
            "content": "There are a lot of stock images available in our website folder under the path /home/marketing/stock/nature",
            "title": "Marketing Stock Photos",
            "color": "4",
            "entityId": "27000000016001"
        }, {
            "content": "Hi Team, I am very much interested in the recent app that you have launched and want to purchase it for 25 users in my organization. Since it is a bulk purchase, I wanted to know if you can offer us any special discounts for the same.  Thanks, Anderson.",
            "title": "App Discounts",
            "color": "3",
            "entityId": "36000000008001"
        }, {
            "content": "Billboards
            Ads
            Target leads
            Email Campaigns ",
            "title": "Sales Improvement Ideas",
            "color": "2",
            "entityId": "36000000007001"
        }, {
            "content": "- Storage and plan details  - Free account accessibility - Docs storage - Workplace plans ",
            "title": "Comparison Page Must-Have",
            "color": "1",
            "entityId": "36000000006001"
        }]
    }
}