Get Details of a Specific Note
Purpose
This API is used to retrieve the details of a specific note.
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/{groupId}/{noteId}
or
For Personal :
https://mail.zoho.com/api/notes/me/{noteId}
Path Parameters
- groupId* long
- Specifies the unique ID of the group.
- This parameter can be retrieved from the Get all groups API.
- noteId* long
- Specifies the unique identifier used for the note whose details are to be retrieved.
- This parameter can be retrieved from the Get all notes 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 colour 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.
* - Mandatory parameter
Response Codes
Refer here for the response codes and their meaning.
``
Sample Request - For Group Notes
Copied
Sample Request - For Personal Notes
Copied
Sample Success Response
Copied
Sample Failure Response
Copied