Get All Collections in Group/Personal

Purpose

This API is used to retrieve all collections of the user in the group/personal.

OAuth Scope

Use the scope

ZohoMail.links.ALL (or) ZohoMail.links.READ

to generate the Authtoken.

ALL - Grants full access to links.

READ - Grants access to read links

Request URL

Method: GET

For Group :

https://mail.zoho.com/api/links/groups/{groupId}/collections

For Personal :

https://mail.zoho.com/api/links/me/collections

Path Parameters

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

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request - For Group

Copiedcurl "https://mail.zoho.com/api/links/groups/84626808/collections" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

Sample Request - For Personal

Copiedcurl "https://mail.zoho.com/api/links/me/collections" \
-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": [
    {
      "collectionId": "3764869000000006003",
      "collectionName": "General"
    },
    {
      "collectionId": "3764869000000009001",
      "collectionName": "category1"
    },
    {
      "collectionId": "3764869000000010001",
      "collectionName": "category2"
    }
  ]
}

Sample Failure Response

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