Get All Users

Purpose

To get a list of all users in your account using Widget API.

Request Format

ZOHO.RECRUIT.API.getAllUsers({
"Type": "{type}"
});

Parameters

Parameter Name	Data Type	Description
type	String	AllUsers To list all users in your org (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 ConfirmedUsers To get the list of confirmed users NotConfirmedUsers To get the list of 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 Recruit user

Parameter Name

Data Type

Description

type

String

AllUsers

To list all users in your org (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

ConfirmedUsers

To get the list of confirmed users

NotConfirmedUsers

To get the list of 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 Recruit user

Sample Request

CopiedZOHO.RECRUIT.API.getAllUsers({
    "Type": "AllUsers"
}).then(function(successResponse) {
   
}, function(errorResponse) {
   
});

Sample Response

Copied{
    "users": [
       {
            "country": null,
            "role": {
                "name": "Recruiter Admin",
                "id": "2445013000000026005"
            },
            "city": null,
            "signature": null,
            "name_format": "Salutation,First Name,Last Name",
            "language": "en_US",
            "locale": "en_US",
            "personal_account": true,
            "default_tab_group": "0",
            "street": null,
            "alias": "Charan",
            "theme": {
                "normal_tab": {
                    "font_color": "#FFFFFF",
                    "background": "#222222"
                },
                "selected_tab": {
                    "font_color": "#FFFFFF",
                    "background": "#222222"
                },
                "new_background": "#018EE0",
                "background": "#F3F0EB",
                "screen": "fixed",
                "type": "default"
            },
            "id": "2445013000000114007",
            "state": null,
            "country_locale": "en_US",
            "fax": null,
            "first_name": "Particia",
            "email": "p.boyle@zylker.com",
            "zip": null,
            "decimal_separator": "en_IN",
            "website": null,
            "time_format": "hh:mm a",
            "profile": {
                "name": "Administrator",
                "id": "2445013000000026011"
            },
            "mobile": null,
            "last_name": "Boyle",
            "time_zone": "IST",
            "zuid": "11290182",
            "confirm": true,
            "full_name": "Patricia Boyle",
            "territories": [],
            "phone": null,
            "dob": null,
            "date_format": "MM/dd/yyyy",
            "status": "active"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}