GET - Fetch a Specific Domain Details

Purpose

The API fetches the detailed information about a particular domain in the specified organization.

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/{domainName}

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.
  • domainname* string
    • This parameter specifies the name of the domain whose details are to be retrieved. Ex: zylker.com

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

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

Sample Response

Copied{
   "status": {
       "code": 200,
       "description": "success"
   },
   "data": {
       "lastName": "T",
       "isDomainAlias": false,
       "mxstatus": "expired",
       "verificationStatus": true,
       "dkimstatus": false,
       "zoid": 699103332,
       "catchAllExcludeAddresses": [],
       "verifiedBy": 699104950,
       "URI": "https://mail.zoho.com/api/organization/699103332/domains/zylkerbiz.com",
       "domainId": "1082700000213855787",
       "verifiedByAddress": "test@zylkerbiz.com",
       "firstName": "test",
       "spfstatus": false,
       "subDomainStripping": 0,
       "HTMLVerificationCode": "94873515",
       "verifiedDate": 1619586519236,
       "dkimDetailList": [
           {
               "isDefault": false,
               "isVerified": false,
               "selector": "zmail",
               "publicKey": "v=DKIM1; k=rsa; p=MWGfMA0GCUpGNIb3DQEBAQUAA4GNADCBiQKBgQCNTHXgi6v4fGVy6y6Z2KjLVuM0T7TEWTHgjGxVQWdlLvMgmIPxEBEXZchCm4KHpYiAdflcPRQy1cYW676JRJaoIZw3szGkSOkJsxhdiwwTYBBTGM478WFJ2bZYN2wMBT9jOF1oj5qeiCHszHbsHLcSEiFlPJD65eA/yZqMZdDv2QIDAQAB",
               "hashType": "sha256",
               "domainId": "1082700000213850787",
               "dkimId": "1082700000213855089"
           }
       ],
       "domainName": "zylkernew.com",
       "mailHostingEnabled": true,
       "createdTime": 1619586448940,
       "CNAMEVerificationCode": "zb94873515",
       "isExpired": true,
       "isRegisteredByZoho": false,
       "primary": false
   }
}