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.
Request URL
Group Notes
https://mail.zoho.com/api/notes/groups/<groupid>
Personal Notes
https://mail.zoho.com/api/notes/me
Request Parameters
Parameter | Data Type | Allowed Values | Description |
GroupID* | Long | The unique identifier used for groups in the organization | |
limit | Integer | 1 - 499 | The number of notes that you would like to retrieve |
after | Integer | 1 - no. of notes | The notes number from which the retrieval has to be done |
fields | String |
|
(If no field is entered, all the details will be retrieved.) |
* - Mandatory parameters
Response Codes
Please refer Response Codes.
Group Notes
Sample Request
Copiedhttps://mail.zoho.com/api/notes/groups/53658048?limit=8
Sample Response
Copied{
"status": {
"code": 200,
"description": "success"
},
"data": {
"list": [{
"content": "That's amazing and I suggest the Agile process could still be researched and ppt could elaborate on the technology.",
"title": "Agile process",
"namespaceId": "1726251",
"color": "1",
"entityId": "30000000088001",
"bookId": "36000000002001",
"bookName": "Marketing"
}, {
"content": "Book the venue
Invite panelists and reporters
Get a copy of agenda from the events team
Give a head count to the events team to procure the refreshments ",
"title": "Press meet",
"namespaceId": "1726251",
"color": "1",
"entityId": "30000000087001",
"bookId": "36000000002001",
"bookName": "Marketing"
}, {
"content": "Highlight the exclusive features
Include a Sneak - peek of the upcoming feature updates ",
"title": "Client Demo",
"namespaceId": "1726251",
"color": "3",
"isFavorite": "true",
"entityId": "36000000040005",
"bookId": "36000000005001",
"bookName": "Zylker"
}, {
"content": "new note sample note content",
"title": "Title",
"namespaceId": "1726251",
"color": "2",
"isFavorite": "true",
"entityId": "36000000040003",
"bookId": "36000000005001",
"bookName": "grpbook1"
}, {
"content": "Make title caps
Make sure all title fonts are the same
Check Images - wrap text around ",
"title": "Comments on Webpage design",
"namespaceId": "1726251",
"color": "1",
"entityId": "36000000040002",
"bookId": "36000000002001",
"bookName": "Marketing"
}, {
"content": "What all can be for the customer event
Send survey
Arrange gifts
Finalise lunch menu
Organize puzzles
Need to check!",
"title": "Event Checklist",
"namespaceId": "1726251",
"color": "1",
"entityId": "36000000040001",
"bookId": "36000000002001",
"bookName": "Events"
}, {
"content": "Please make note of the typos and give me a couple of prototypes to consider",
"title": "Comparison pages",
"namespaceId": "1726251",
"color": "1",
"isFavorite": "true",
"entityId": "36000000037002",
"bookId": "36000000002001",
"attachments": [{
"fileName": "one.txt",
"attachmentID": "1"
}],
"bookName": "Marketing"
}, {
"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, And
",
"title": "App Discounts",
"namespaceId": "1726251",
"color": "1",
"entityId": "36000000037001",
"bookId": "36000000002001",
"attachments": [{
"fileName": "one.txt",
"attachmentID": "1"
}],
"bookName": "Sales"
}],
"pagination": {
"next": "http://mail.zoho.com/api/notes/groups/1726251?after=8"
}
}
}
Personal Notes
Sample Request
Copiedhttp://mail.zoho.com/api/notes/me?limit=8
Sample Response
Copied{
"status": {
"code": 200,
"description": "success"
},
"data": {
"list": [{
"content": "That's amazing and I suggest the Agile process could still be researched and ppt could elaborate on the technology.",
"title": "Agile process",
"color": "1",
"entityId": "30000000088001",
"bookId": "36000000002001",
"bookName": "Marketing"
}, {
"content": "Book the venue
Invite panelists and reporters
Get a copy of agenda from the events team
Give a head count to the events team to procure the refreshments ",
"title": "Press meet",
"color": "1",
"entityId": "30000000087001",
"bookId": "36000000002001",
"bookName": "Marketing"
}, {
"content": "Highlight the exclusive features
Include a Sneak - peek of the upcoming feature updates ",
"title": "Client Demo",
"color": "3",
"isFavorite": "true",
"entityId": "36000000040005",
"bookId": "36000000005001",
"bookName": "Zylker"
}, {
"content": "Billboards
Ads
Target leads
Email Campaigns ",
"title": "Sales promotion",
"color": "2",
"isFavorite": "true",
"entityId": "36000000040003",
"bookId": "36000000005001",
"bookName": "Sales"
}, {
"content": "Make title caps
Make sure all title fonts are the same
Check Images - wrap text around ",
"title": "Comments on Webpage design",
"color": "1",
"entityId": "36000000040002",
"bookId": "36000000002001",
"bookName": "Marketing"
}, {
"content": "What all can be for the customer event
Send survey
Arrange gifts
Finalise lunch menu
Organize puzzles
Need to check!",
"title": "Event Checklist",
"color": "1",
"entityId": "36000000040001",
"bookId": "36000000002001",
"bookName": "Events"
}, {
"content": "Please make note of the typos and give me a couple of prototypes to consider",
"title": "Comparison pages",
"color": "1",
"isFavorite": "true",
"entityId": "36000000037002",
"bookId": "36000000002001",
"attachments": [{
"fileName": "one.txt",
"attachmentID": "1"
}],
"bookName": "Marketing"
}, {
"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",
"title": "App Discounts",
"color": "1",
"entityId": "36000000037001",
"bookId": "36000000002001",
"attachments": [{
"fileName": "one.txt",
"attachmentID": "1"
}],
"bookName": "Sales"
}],
"pagination": {
"next": "http://mail.zoho.com/api/notes/me?after=8"
}
}
}