GET - Get Organization Subscription Details

Purpose

This API is used to retrieve the subscription details along with the storage information, with allotted and available storage details for the given organization. The details are available for all users along with their individual allotted storage details.

OAuth Scope

Use the scope

ZohoMail.organization.subscriptions.ALL (or) ZohoMail.organization.subscriptions.READ 

to generate the Authtoken.

ALL - Full access to the organization.

READ - Read an organization's subscription details.

Request URL

Method: GET

https://mail.zoho.com/api/organization/<zoid>/storage

Path Parameters

  • zoid long, mandatory
    • This denotes the unique Zoho Organization Identifier for the organization.
  • limit integer
    • This is used to get the storage details of users in batches. 
    • It specifies the number of users for which the details of storage need to be retrieved.
  • start integer
    • This is used to get the storage details of users in batches. 
    • It specifies the order number from which the data retrieval should start.
    • It works better when used with the limit parameter.

Response Codes

Refer here for the response codes and their meaning.

Sample Response

Copied{
    "status": {
        "code": 200,
        "description": "success"
    },
    "data": {
        "userList": [
            {
                "totalStorage": 5,
                "mailBox": true,
                "basicStorage": "free",
                "usedStorage": 0,
                "zuid": 76006481
            }
        ]
    }
}