Get All Collections in Groups

Purpose

This API is used to retrieve all collections in groups.

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

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

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/links/groups/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": [
    {
      "groupId": "84626808",
      "name": "test",
      "collection": [
        {
          "collectionId": "3764869000000009001",
          "collectionName": "test1"
        },
        {
          "collectionId": "3764869000000010001",
          "collectionName": "test2"
        }
      ]
    },
    {
      "groupId": "78762952",
      "name": "test3",
      "collection": []
    },
    {
      "groupId": "79002274",
      "name": "test4",
      "collection": []
    },
    {
      "groupId": "84789189",
      "name": "test5",
      "collection": []
    },
    {
      "groupId": "78838763",
      "name": "test6",
      "collection": []
    }
  ]
}

Sample Failure Response

Copied{
  "data": {
    "errorCode": "INVALID_METHOD"
  },
  "status": {
    "code": 404,
    "description": "Invalid Input"
  }
}