User APIs

In Zoho Recruit, users are those who are allowed to access and manage records. These users can be defined under various profiles and roles such as Administrators, Standard, etc.

Using User APIs, you can retrieve the basic information of users available in Zoho Recruit. 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 Recruit users with an Administrative profile. A detailed explanation of the Users API and the examples are shown below:

Get users

Purpose

To retrieve user 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 users available in your account.

Request URL

https://recruit.zoho.com/recruit/v2/users

Request Method

GET

Scope

scope=ZohoRecruit.users.{operation_type}

Possible operation types
ALL - Full access to users READ - get user data

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

Copiedcurl "https://recruit.zoho.com/recruit/v2/users?type=AllUsers"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

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
    }
}