Get All Books

Purpose

This API serves the purpose of fetching the details of all books associated with a group or personal.

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

Group Notes :

https://mail.zoho.com/api/notes/groups/{groupId}/books

Personal Notes :

https://mail.zoho.com/api/notes/me/books

Path Parameters

groupId* long
- Specifies the unique ID of the group.
- This parameter can be retrieved from the Get all groups API.

Query Parameters

defaultProject* long
- Specifies whether the default book should be highlighted in the response.
- This parameter allows users to quickly identify the default book among the list of books returned by the API.
- Allowed values:
  - true - The default book will be highlighted under the defaultProject key in the JSON response.
  - false - The default book will not be highlighted under the defaultProject key in the JSON response.

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request - For Group Notes

Copiedcurl "https://mail.zoho.com/api/notes/groups/84626808/books?defaultProject=true" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

Sample Request - For Personal Notes

Copiedcurl "https://mail.zoho.com/api/notes/me/books?defaultProject=true" \
-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": {
    "projects": [
      {
        "bookName": "General",
        "bookId": "3764869000000005003"
      },
      {
        "bookName": "noteBook0",
        "bookId": "3764869000000007001"
      },
      {
        "bookName": "noteBook1",
        "bookId": "3764869000000012001"
      }
    ],
    "defaultProject": {
      "bookName": "General",
      "bookId": "3764869000000005003"
    }
  }
}

Sample Failure Response

Copied{
  "status": {
    "code": 500,
    "description": "Operation not permitted"
  },
  "data": {}
}