Users APIs

In Zoho CRM, the user is the one who is allowed to access and manage the CRM records. These users can be defined under various profiles and categories such as Administrators, Standard, etc,.

Using the Users APIs, you can retrieve the basic information of your available CRM users. Use the type parameter to get the required list of users. For example, you can set the param type as AdminUsers, to get the list of CRM users with Administrative profile. The detailed explanation of the Users API and the examples are shown below:

Get Users

Purpose

To retrieve the users' data specified in the API request. You can specify the type of users that needs to be retrieved using the Users API. For example, use type=AllUsers, to get the list of all the CRM users available.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/users

To get a specific user:
{api-domain}/crm/{version}/users/{user_id}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

If-Modified-Since: Use this header to get the list of recently modified users. Example: 2019-07-25T15:26:49+05:30

Scope

scope=ZohoCRM.users.{operation_type}

Possible operation types

ALL - Full access to users
READ - Get user data

Parameters
  • typestring, optional

    Specify the type of the users you want to retrieve.

    • AllUsers - To list all users in your organization (both active and inactive users).
    • ActiveUsers - To get the list of all the Active Users.
    • DeactiveUsers - To get the list of all the users who were deactivated.
    • ConfirmedUsers - To get the list of all the confirmed users.
    • NotConfirmedUsers - To get the list of all the non-confirmed users.
    • DeletedUsers - To get the list of deleted users.
    • ActiveConfirmedUsers - To get the list of active users who are also confirmed.
    • AdminUsers - To get the list of admin users.
    • ActiveConfirmedAdmins - To get the list of active users with the administrative privileges and are also confirmed.
    • CurrentUser - To get the current CRM user.
  • pageinteger

    To get the list of user records from the respective pages. Default value is 1.

  • per_pageinteger

    To set the number of user records to be retrieved per page. The default and the maximum possible value is 200.

  • idsstring, optional

    Represents the unique ID of the users. You can specify up to 100 user IDs.

Note

  • The page and per_page parameters are used to fetch user records according to their position in CRM. Let us assume that the user has to fetch 400 user records. The maximum number of user records that one can get for an API call is 200. So, for the user records above the 200th position, they cannot be fetched. By using the page (1 and 2) and per_page (200) parameter, the user can fetch all 400 user records using 2 API calls.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v5/users?type=AllUsers"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response JSON Keys

  • country, city, street, state, country_locale, zipstring

    Represents the address of the user.

  • roleJSON object

    Represents the name and ID of the role of the user.

  • localestring

    Represents the user's locale. For instance, 'en_IN'.

  • Modified_ByJSON object

    Represents the name and ID of the user who last modified the user's details.

  • Currencystring

    Represents the user's currency preference.

  • aliasstring

    Represents the alias name of the user.

  • idstring

    Represents the unique ID of the user.

  • fax, email, mobile, phonestring

    Represents the contact details of the user.

  • first_namestring

    Represents the first name of the user.

  • Reporting_ToJSON object

    Represents the name and ID of the user to whom the user reports to.

  • created_timestring

    Represents the date and time at which the user was created.

  • websitestring

    Represents the user's website details.

  • Modified_Timestring

    Represents the date and time at which the user's details were last modified.

  • profileJSON object

    Represents the name and ID of the profile of the user.

  • last_namestring

    Represents the last name of the user.

  • time_zonestring

    Represents the current user's timezone.

  • created_byJSON object

    Represents the name and ID of the user who created the user.

  • zuidstring

    Represents the ZUID of the current user.

  • confirmboolean

    Represents if the user is a confirmed user.
    true: The user is a confirmed user.
    false: The user is not a confirmed user.

  • full_namestring

    Represents the full name of the user in the format specified in "name_format" key.

  • dobstring

    Represents the date of birth of the user.

  • date_formatstring

    Represents the date format. For instance, 'MM/dd/yyyy'.

  • time_formatstring

    Represents the time format. For instance, 'hh:mm a'.

  • statusstring

    Represents the status of the user.
    active: The user is active.
    inactive: The user is inactive.

  • signaturestring

    Represents the user's signature.

  • name_format__sstring

    Represents the format of the full_name of the user. For instance, 'Salutation,First Name,Last Name'.

  • sort_order_preference__sstring

    Represents how the records in the response are sorted based on either the last name or first name. The default sorting happens by the record IDs.

  • languagestring

    Represents the language in which the user accesses the CRM. For instance, 'en_US'.

  • microsoftboolean

    Represents if the user is a microsoft user.
    true: The user is a microsoft user.
    false: The user is a microsoft user.

  • personal_accountboolean

    Represents if the user is the only user in the organization.
    true: The user is the only user in the organization.
    false: The user is not the only user in the organization.

  • Isonlineboolean

    Represents if the user is online.
    true: The user is online.
    false: The user is offline.

  • themeinteger

    Represents the details of the theme selected by the user.

  • Number_Separatorstring

    Represents the format of the number fields. The possible values are "comma", "period" and "space".

  • Decimal_Separatorstring

    Represents the format of the decimal fields. The possible values are "comma" and "period".

Sample Response

Copied{
    "users": [
        {
            "country": "US",
            "name_format__s": "Salutation,First Name,Last Name",
            "language": "en_US",
            "microsoft": false,
            "$shift_effective_from": null,
            "Currency": "INR",
            "id": "3652397000000186017",
            "state": "Tamil Nadu",
            "fax": null,
            "country_locale": "en_US",
            "sandboxDeveloper": false,
            "zip": null,
            "decimal_separator": "Period",
            "created_time": "2018-11-14T15:30:11+05:30",
            "time_format": "hh:mm a",
            "offset": 19800000,
            "profile": {
                "name": "Administrator",
                "id": "3652397000000026011"
            },
            "created_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "zuid": "678521418",
            "full_name": "Patricia Boyle",
            "phone": null,
            "dob": null,
            "sort_order_preference__s": "First Name,Last Name",
            "status": "active",
            "role": {
                "name": "CEO",
                "id": "3652397000000026005"
            },
            "customize_info": {
                "notes_desc": false,
                "show_right_panel": null,
                "bc_view": null,
                "show_home": false,
                "show_detail_view": true,
                "unpin_recent_item": null
            },
            "city": null,
            "signature": null,
            "locale": "en_US",
            "personal_account": false,
            "Isonline": true,
            "default_tab_group": "0",
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "street": null,
            "$current_shift": null,
            "alias": null,
            "theme": {
                "normal_tab": {
                    "font_color": "#FFFFFF",
                    "background": "#222222"
                },
                "selected_tab": {
                    "font_color": "#FFFFFF",
                    "background": "#222222"
                },
                "new_background": null,
                "background": "#F3F0EB",
                "screen": "fixed",
                "type": "default"
            },
            "first_name": "Patricia",
            "email": "p.boyle_admin@abc.com",
            "status_reason__s": null,
            "website": null,
            "Modified_Time": "2022-10-17T16:38:37+05:30",
            "$next_shift": null,
            "mobile": null,
            "last_name": "Boyle",
            "time_zone": "IST",
            "number_separator": "Comma",
            "confirm": true,
            "date_format": "MMM d, yyyy",
            "category": "regular_user"
        },
        {
            "country": null,
            "role": {
                "name": "Manager",
                "id": "3652397000000026008"
            },
            "city": null,
            "language": "en_US",
            "locale": "en_US",
            "microsoft": false,
            "Isonline": false,
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "$shift_effective_from": null,
            "street": null,
            "$current_shift": null,
            "Currency": "INR",
            "alias": null,
            "id": "3652397000000281001",
            "state": null,
            "fax": null,
            "country_locale": "en_US",
            "sandboxDeveloper": false,
            "first_name": "Will",
            "email": "w.grandon@gmail.com",
            "zip": null,
            "status_reason__s": null,
            "decimal_separator": "Period",
            "created_time": "2018-12-05T10:02:20+05:30",
            "website": null,
            "Modified_Time": "2022-03-23T11:41:38+05:30",
            "time_format": "hh:mm a",
            "$next_shift": null,
            "offset": 19800000,
            "profile": {
                "name": "Free",
                "id": "3652397000001614008"
            },
            "mobile": null,
            "last_name": "Grandon",
            "time_zone": "Asia/Kolkata",
            "number_separator": "Comma",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "zuid": "679952958",
            "confirm": true,
            "full_name": "Will Grandon",
            "phone": null,
            "dob": null,
            "sort_order_preference__s": "null",
            "date_format": "MMM d, yyyy",
            "category": "regular_user",
            "status": "active"
        },
        {
            "country": null,
            "role": {
                "name": "Manager",
                "id": "3652397000000026008"
            },
            "city": null,
            "language": "en_US",
            "locale": "en_US",
            "microsoft": false,
            "Isonline": false,
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "$shift_effective_from": null,
            "street": null,
            "$current_shift": null,
            "Currency": "INR",
            "alias": null,
            "id": "3652397000001460001",
            "state": null,
            "fax": null,
            "country_locale": "en_US",
            "sandboxDeveloper": false,
            "first_name": null,
            "email": "patricia.boyle@gmail.com",
            "zip": null,
            "status_reason__s": null,
            "decimal_separator": "Period",
            "created_time": "2019-12-20T13:24:52+05:30",
            "website": null,
            "Modified_Time": "2022-03-23T11:41:38+05:30",
            "time_format": "hh:mm a",
            "$next_shift": null,
            "offset": 0,
            "profile": {
                "name": "Administrator",
                "id": "3652397000000026011"
            },
            "mobile": null,
            "last_name": "patricia.boyle",
            "time_zone": "GMT",
            "number_separator": "Comma",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "zuid": null,
            "confirm": false,
            "full_name": "patricia.boyle",
            "phone": null,
            "dob": null,
            "sort_order_preference__s": "null",
            "date_format": "MMM d, yyyy",
            "category": "regular_user",
            "status": "disabled"
        },
        {
            "country": null,
            "role": {
                "name": "Manager",
                "id": "3652397000000026008"
            },
            "city": null,
            "language": "en_US",
            "locale": "en_US",
            "microsoft": false,
            "Isonline": false,
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "$shift_effective_from": null,
            "street": null,
            "$current_shift": null,
            "Currency": "INR",
            "alias": null,
            "id": "3652397000001464001",
            "state": null,
            "fax": null,
            "country_locale": "en_US",
            "sandboxDeveloper": false,
            "first_name": null,
            "email": "pat11boyle@gmail.com",
            "zip": null,
            "status_reason__s": null,
            "decimal_separator": "Period",
            "created_time": "2019-12-20T13:30:52+05:30",
            "website": null,
            "Modified_Time": "2022-03-23T11:41:38+05:30",
            "time_format": "hh:mm a",
            "$next_shift": null,
            "offset": 19800000,
            "profile": {
                "name": "Administrator",
                "id": "3652397000000026011"
            },
            "mobile": null,
            "last_name": "pat11boyle",
            "time_zone": "Asia/Kolkata",
            "number_separator": "Comma",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "zuid": "698789031",
            "confirm": true,
            "full_name": "pat11boyle",
            "phone": null,
            "dob": null,
            "sort_order_preference__s": "null",
            "date_format": "MMM d, yyyy",
            "category": "regular_user",
            "status": "disabled"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 4,
        "page": 1,
        "more_records": false
    }
}