GET - Get Child Organization Details

Purpose

This API is used to retrieve the details of the child organization.

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Full access to the organization.

READ - Read an organization's details.

Request URL

Method: GET

https://mail.zoho.com/api/organization

(or)

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

Path Parameters

  • zoid long
    • This denotes the unique Zoho Organization Identifier for the child organization.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Response

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "mailboxCount": 1,
    "URI": "https://mail.zoho.com/api/organization/76006415",
    "encryptedZoid": "7d4b5694a64799168f94c4fb749c23bda3115a6062f5f6fbea48c022d91c0323",
    "orgPolicyDetails": {
      "1003505000081813009": "Business Policy"
    },
    "spamVO": {
      "spamProcessType": "complete"
    },
    "superAdminLoginName": "un424230589280310r8id",
    "orgImageUrl": "https://mail.zoho.com/cpanel/mailimage?filename=zmaillogo.png",
    "isMailHostingEnabled": true,
    "licenseCount": 5,
    "superAdminFullName": "zylkermail Z",
    "orgCreationTime": 1683626711822,
    "orgName": "zylkermail",
    "planType": "free",
    "isOfferAvailable": false,
    "primaryDomainName": "zylker-mail.com",
    "zoid": 76006415,
    "domains": [
      "zylker-mail.com"
    ],
    "usersCount": 1,
    "partnerOrgCount": 0,
    "groupCount": 0,
    "basePlan": "Mail Free",
    "zaid": "76005578",
    "sharedGroupCount": 0,
    "isDomainMarkingExist": false,
    "superAdmin": "zylkermail@zylker-mail.com",
    "isEmailConfirmed": true
  }
}