Get All Notes in a Book
Purpose
Use this API to retrieve all notes associated with a particular book in either the personal or group context.
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
For Group :
https://mail.zoho.com/api/notes/groups/{zgid}/books/{bookId}
or
For Personal :
https://mail.zoho.com/api/notes/me/books/{bookId}
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.
- bookId* long
- Specifies the unique identifier of the book from which all the notes are to be retrieved.
- This parameter can be retrieved from the Get all books 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.
- title string
- 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
Copied
Sample Request - For Personal
Copied
Sample Success Response
Copied
Sample Failure Response
Copied