GET - Fetch a Specific User Details

Purpose

The API fetches the details of the specified user in the specified organization, when requested by the organization's admin. 

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Grants full access to accounts.

READ - Grants read access to accounts.

Request URL 

Method: GET

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

or

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

Path Parameters

  • zoid* long
    • This parameter denotes the unique Zoho Organization Identifier for the organization. 
    • This value can be retrieved using the GET organization details API.
  • zuid* long
    • This parameter denotes the unique identifier for each user in an organization. 
    • This value can be retrieved using the GET all org user details API.
  • emailAddress* string
    • This parameter specifies the email address of the user whose details are retrieved.

 

Note:

Either zuid or emailAddress is a mandatory parameter in the Request URL.

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request (Using zuid)

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

Sample Request (Using emailAddress)

Copiedcurl "https://mail.zoho.com/api/organization/1234567890/accounts/rebecca@zylker.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": {
        "country": "in",
        "lastLogin": 1719997389714,
        "mxStatus": true,
        "activeSyncEnabled": false,
        "mobileNumber": "",
        "isCustomAdmin": false,
        "incomingBlocked": false,
        "language": "en",
        "type": "ZOHO_ACCOUNT",
        "extraStorage": {},
        "incomingUserName": "rebecca@zylker.com",
        "emailAddress": [
            {
                "isAlias": false,
                "isPrimary": true,
                "mailId": "rebecca@zylker.com",
                "isConfirmed": true
            }
        ],
        "mailboxStatus": "enabled",
        "ediscoveryStorage": {
            "iseDiscoveryStorageEnabled": true,
            "ediscoveryUsedStorage": 0,
            "ediscoveryAllowedStorage": 104857600
        },
        "popBlocked": false,
        "usedStorage": 171,
        "spamcheckEnabled": true,
        "imapAccessEnabled": false,
        "timeZone": "Asia/Kolkata",
        "accountCreationTime": 1716450943660,
        "zuid": 123456789,
        "webBlocked": false,
        "planStorage": 100,
        "firstName": "rebecca",
        "accountId": "5236971000000008002",
        "sequence": 1,
        "mailboxAddress": "rebecca@zylker.com",
        "lastPasswordReset": 1720001704767,
        "tfaEnabled": false,
        "iamStatus": 1,
        "phoneNumer": "",
        "status": true,
        "lastName": "Test",
        "accountDisplayName": "rebecca",
        "role": "member",
        "gender": "NOT_SPECIFIED",
        "accountName": "workdrive",
        "displayName": "rebecca",
        "customFields": [],
        "isLogoExist": false,
        "primaryEmailAddress": "rebecca@zylker.com",
        "enabled": true,
        "mailboxCreationTime": 1716450947316,
        "basicStorage": "professional",
        "lastClient": "SMTP_IN",
        "allowedStorage": 104857600,
        "sendMailDetails": [
            {
                "sendMailId": "5236971000000008004",
                "displayName": "rebecca",
                "serverName": "smtpout.mail.zoho.com",
                "signatureId": "null",
                "serverPort": 25,
                "userName": "rebecca@zylker.com",
                "connectionType": "plain",
                "mode": "mailbox",
                "validated": false,
                "fromAddress": "rebecca@zylker.com",
                "smtpConnection": 0,
                "validationRequired": true,
                "validationState": 0,
                "status": true
            }
        ],
        "popFetchTime": -1,
        "address": {
            "country": "",
            "streetAddr": "",
            "city": "",
            "postalCode": "",
            "state": ""
        },
        "planType": 82,
        "userExpiry": -1,
        "popAccessEnabled": true,
        "imapBlocked": false,
        "iamUserRole": "member",
        "outgoingBlocked": false,
        "policyId": {
            "1082700000192558003": "Business Policy",
            "zoid": 1234567890
        },
        "smtpStatus": true,
        "extraEDiscoveryStorage": {}
    }
}