GET - All Org Users Details

Purpose

The API retrieves all the user's details for the specified Organization Id when requested by the admin of the organization.

Request URL

https://<hostname>/api/organization/<zoid>/accounts

Scope

organization.accounts

Request Parameters

Parameter	Data Type	Description
zoid*	Integer	zoid - The unique Zoho Organization Identified for the organization
limit	Integer	limit - Used to get the user details in batches. Specify the number of users for whom the user details need to be retrieved. By default, the limit is 10.
start	Integer	start - Used to get the user details of in batches. Specify the order number from which the data retrieval should start. Works better when used with limit parameter. By default, the start value is 0.

* - Mandatory parameter

Response Codes

Please refer Response Codes.

Sample Response

Copied{
   "status": {
      "code": 200,
      "description": "success"
   },
   "data": [
      {
         "URI": " https://mail.zoho.com/api/organization/123456/accounts/6000000000123",
         "displayName": "Hermes Mercury",
         "zuid": 841001,
         "role": "member",
         "address": {
            "streetAddr": "1, Solar System St",
            "city": "Milky Way Galaxy Ave",
            "postalCode": "11001",
            "state": "Virgo Super Cluster",
            "country": "Laniakea",
            "phone": "111 011 01111",
            "mobile": "111 111 11111"
         },
         "accountId": 600000000001,
         "accountName": "Solar System",
         "incomingUserName": "mercury@solarsystem.com",
         "tfaEnabled": false,
         "type": "ZOHO_ACCOUNT",
         "sequence": 1,
         "sendMailDetails": [
            {
               "sendMailID": 60000000000001,
               "fromAddress": "mercury@solarsystem.com",
               "status": true,
               "mode": "mailbox",
               "displayName": "Hermes Mercury",
               "serverName": "incoming.zohocorpin.com",
               "serverPort": 9225,
               "userName": "mercury@solarsystem.com",
               "password": "planet@1",
               "validated": true,
               "connectionType": "plain",
               "validationRequired": true
            }
         ],
         "popAccessEnabled": true,
         "allowedStorage": 15728640,
         "usedStorage": 2048000,
         "imapAccessEnabled": true,
         "outgoingBlocked": false,
         "incomingBlocked": false,
         "spamCheckEnabled": true,
         "activeSyncEnabled": true,
         "policyId": {
            "1000000000299": "Zoho Mail Business Policy"
         },
         "primaryEmailAddress": "mercury@solarsystem.com",
         "emailAddress": [
            {
               "isPrimary": false,
               "isConfirmed": true,
               "mailId": "mercury@solarsystem.com",
               "isAlias": false
            }
         ],
         "accountEnabled": true
      }
   ]
}