getUsers Method

Table of Contentsup

 Purpose

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

 Request URL

XML Format:
https://<APPDOMAIN>/crm/private/xml/Users/getUsers?type=The Type of User

JSON Format:
https://<APPDOMAIN>/crm/private/json/Users/getUsers?type=The Type of User

 Auth Token

Auth Token is an encrypted alphanumeric string that is required to authenticate your CRM account credentials. A valid user's Authentication Token is necessary to access the API. When making an API request, send the authentication token in the Authorization header as shown below:

https://<APPDOMAIN>/crm/private/xml/Users/getUsers?type=The Type of User

Header:

Authorization=1000XXXX65.1000XXXX44.caXXXXXXXXXXXX

(See Using Authentication Token )

 Request Parameters

ParameterData TypeDescription
newFormatIntegernewFormat=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*StringThis 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>