Developer API Help

getUsers Method

Purpose

You can use the getUsers method to get the list of users in your organization.

Request URL

XML Format:
https://crm.zoho.com/crm/private/xml/Users/getUsers?authtoken=Auth Token&scope=crmapi&type=The Type of User

JSON Format:
https://crm.zoho.com/crm/private/json/Users/getUsers?authtoken=Auth Token&scope=crmapi&type=The Type of User

Request Parameters

Parameter Data Type Description
authtoken* String Encrypted alphanumeric string to authenticate your Zoho credentials. 
scope* String Specify the value as crmapi.
newFormat Integer newFormat=1: To exclude fields with "null" values while inserting data from your CRM account.
newFormat=2: To include fields with "null" values while inserting data from your CRM account.
type* String This parameter takes one of the following values:
AllUsers
To list all users in your organization (both active and inactive users)
ActiveUsers
To get the list of all Active Users 
DeactiveUsers
To get the list of all users who were deactivated
AdminUsers
To get the list of all users with the Administrative privileges
ActiveConfirmedAdmins
To get the list of users with the administrative privileges and are also confirmed

* - Mandatory parameter

Note:

  • Refer the Release Notes page to learn more about enhancements made in the API implementation.

Sample Response

In this case, type = AllUsers

<users>
      <user id="501240000000541313" email="andrew@zohocorp.com" role="CEO" profile="Administrator" status="active" confirm="true">andrew</user>
      <user id="501234132412341135" email="tyson@zohocorp.com" role="Manager" profile="Standard" status="active" confirm="true">tyson</user>
      <user id="501234565431234521" email="kelly@zohocorp.com" role="Manager" profile="Standard" status="active" confirm="false">kelly</user>
      <user id="512343454676898643" email="frank@zohocorp.com" role="CEO" profile="Standard" status="active" confirm="false">frank</user>
      <user id="512445678909865545" email="sophia@zohocorp.com" role="CEO" profile="Administrator" status="active" confirm="true">sophia</user>
</users>

Top