GET - Get All Account Restrictions

Purpose

This API is used to retrieve details of all the account restrictions created.

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Provides full access to policy.

READ - Retrieve the list of account restrictions.

Request URL 

Method: GET

https://mail.zoho.com/api/organization/{zoid}/policy/accountRestriction

Path Parameters

  • zoid* long
    • This parameter denotes the unique Zoho Organization Identifier for the organization.
    • This parameter can be retrieved from the Get Organization Details API.

 

Query Parameters

  • start int
    • This parameter specifies the start sequence number of restrictions to be retrieved. 
    • The default value is 0.
  • limit int
    • This parameter specifies the number of restrictions to be retrieved from the start value mentioned. 
    • The default value is 10.
  • searchKey string
    • This parameter specifies the particular data to search for.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/organization/12345678/policy/accountRestriction?limit=10&start=0" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken ***"

Sample Response

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": [
    {
      "addToCloud": true,
      "outgoingBccStatus": true,
      "restrictionName": "test",
      "attachFromcloud": true,
      "signatureCustomizationStatus": true,
      "zoid": 12345678,
      "externalPopStatus": false,
      "exportRestrictionStatus": true,
      "mobileAppStatus": true,
      "hamburgerStatus": true,
      "shareFolderStatus": true,
      "showSettingsStatus": true,
      "policyCount": "0",
      "maxAttachmentSize": 10,
      "importRestrictionStatus": true,
      "restrictionID": "1003505000063578001",
      "streamStatus": true
    },
    {
      "addToCloud": false,
      "outgoingBccStatus": true,
      "restrictionName": "M217",
      "attachFromcloud": false,
      "signatureCustomizationStatus": false,
      "zoid": 12345678,
      "externalPopStatus": true,
      "exportRestrictionStatus": true,
      "mobileAppStatus": true,
      "hamburgerStatus": true,
      "shareFolderStatus": true,
      "showSettingsStatus": true,
      "policyCount": "0",
      "maxAttachmentSize": 10,
      "importRestrictionStatus": true,
      "restrictionID": "1003505000063845015",
      "streamStatus": true
    }
  ]
}