GET - Fetch All Domains

Purpose

The API fetches a list of all the domains added to the specified organization, including details such as the verification status and verification code.

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Grants full access to domains.

READ - Grants read access to domains.

Request URL

Method: GET

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

Path Parameters

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

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/organization/1234567890/domains" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken 1********"

Sample Response

Copied{
   "status": {
      "code": 200,
      "description": "success"
   },
   "data": {
      "superAdmin": "superadmin@zylker.com",
      "admin": [
         "admin@zylker.com"
      ],
      "users": [
         "user1@zylker.com",
         "user2@zylker.com",
         "user3@zylker.com",
         "user4@zylker.com",
         "user5@zylker.com"
      ],
      "domainVO": [
         {
            "URI": "https://mail.zoho.com/api/domains/zylker.com",
            "zoid": 1234567890,
            "domainId": 1000000000337,
            "domainName": "zylker.com",
            "createdTime": 1420450716601,
            "CNAMEVerificationCode": "zb15107424",
            "HTMLVerificationCode": "1510742457156",
            "verificationStatus": true,
            "status": "enabled",
            "verifiedDate": 1420450792354,
            "verifiedBy": 731521,
            "domainAlias": "",
            "mailHostingEnabled": true,
            "isRegisteredByZoho": false,
            "primary": true,
            "isDomainAlias": false
         },
         {
            "URI": "https://mail.zoho.com/api/domains/zylker.org",
            "zoid": 1234567890,
            "domainId": 1000000000338,
            "domainName": "zylker.org",
            "createdTime": 1423661913245,
            "CNAMEVerificationCode": "zb15107445",
            "HTMLVerificationCode": "1510744557159",
            "verificationStatus": true,
            "status": "enabled",
            "verifiedDate": 1420450792354,
            "verifiedBy": 731521,
            "domainAlias": "",
            "mailHostingEnabled": true,
            "isRegisteredByZoho": false,
            "primary": false,
            "isDomainAlias": false
         }
      ]
   }
}