Search User

To search a user in your organization.

https://www.zohoapis.com/crm/v2/users

GET

scope=ZohoCRM.users.ALL
(or)
scope=ZohoCRM.users.READ

Possible operation types
ALL - Full access to data READ - Get user data

Attributes

Data Type

Mandatory

Description

filters Show properties

JSON Array

Yes

Specifies the criteria based on which you want to search the records.

Attributes	Data Type	Mandatory	Description
field	String	Yes	The API name of the field based on whose value you want to search the users
value	String	Yes	The value to be searched
comparator	String	Yes	The value of the comparator such as "equal", "not_equal" etc. Refer to the Fields and allowed comparators table for more information.

Field API Names	Allowed comparators	Example
first_name, last_name, alias, profile.name, role.name, street, city, state, country, fax, mobile, website, locale, country_locale, time_zone	equal, not_equal, contains, not_contains, like, not_like	"Patricia", "Administrator", "CEO", "en_US", "US", "Asia/Kolkata".
role, role.id, profile, profile.id, Isonline, created_by, created_by.id, created_by.name, modified_by, modified_by.id, modified_by.name, zuid, confirm, reporting_to, reporting_to.id, reporting_to.name, reporting_to.email, reporting_to.zuid, reporting_to.userid, currency	equal, not_equal	"410405000002188009", "newcrm@zoho.com", "true/false", "USD". Note: "In "created_by.name", "modified_by.name", "reporting_to.name", "name" implies the full name.
time_format	equal, not_equal, like, not_like	"hh:mm a" for 12 hours or "HH:mm" for 24 hours format.
territories	in, not_in	Territory IDs as JSON Array. Example: ["410405000002200112","410405000002200345"]
created_time, Modified_Time,	equal, not_equal, greater_equal, greater_than, less_equal, less_than, between, not_between	"2017-12-28T12:41:25+05:30". For "between" and "not_between", give the values in a JSON Array like "["2017-11-26T12:41:25+05:30", "2017-12-26T12:41:25+05:30"]"

Field	Allowed comparators	Example
Email, Multi-Line, Single Line, Phone, Pick List	equal, not_equal, like, not_like, contains, not_contains	"newcrm@zoho.com", "picklist_value_1".
role, role.id, profile, profile.id, Isonline, created_by, created_by.id, created_by.name, modified_by, modified_by.id, modified_by.name, zuid, confirm, reporting_to, reporting_to.id, reporting_to.name, reporting_to.email, reporting_to.zuid, reporting_to.userid, currency	equal, not_equal	"410405000002188009", "newcrm@zoho.com", "true/false", "USD". Note: "In "created_by.name", "modified_by.name", "reporting_to.name", "name" implies the full name.
Decimal, Percent, Number, Currency, Long integer	equal, not_equal, greater_equal, greater_than, less_equal, less_than	"423.5697", "43.2"
Multi-Select Pick List	in, not_in, contains, not_contains	"value1". For "in" and "not_in" comparators, give the values as a JSON Array like ["value1","value2"]
Date, Date/Time	equal, not_equal, greater_equal, greater_than, less_equal, less_than, between, not_between	2017-12-26" (yyyy-mm-dd). For "between" and "not_between", give the values as a JSON Array like "[ "2017-11-26T12:41:25+05:30", "2017-12-26T12:41:25+05:30"]
Check box	equal, not_equal	true or false.

Note:

The fields "customize_info", "language", "personal_account", "default_tab_group" , "theme" ,"id", "decimal_separator", "offset", "full_name", "date_format" are not supported in this API.
Every criterion inside the filters JSON Array must be a JSON Object.
If there are more than one search criteria, use or or and operators to group the criteria.
Each criterion JSON object can have only one comparator.