Roles APIs

In Zoho Recruit, Administrators assign roles to the users. Roles, such as Recruiter Admin, Recruiter, Hiring Manager, Employee, etc., denote the different levels of employees in a company. Use this API to retrieve information about various roles in Zoho Recruit.

Get roles

Purpose

To retrieve the data of roles through an API request.

Request URL

https://recruit.zoho.com/recruit/v2/settings/roles

To get a specific role:
https://recruit.zoho.com/recruit/v2/settings/roles/{role_id}

Request Method

GET

Scope

scope=ZohoRECRUIT.settings.roles.{operation_type}

Possible operation types
ALL - Full access to roles data READ - get role data

Sample Request

Copiedcurl "https://recruit.zoho.com/recruit/v2/settings/roles"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Sample Response

Copied{
    "roles": [
        {
            "display_label": "Recruiter Admin",
            "share_with_peers": true,
            "name": "Recruiter Admin",
            "id": "486812000000071953",
            "reporting_to": null
        },
        {
            "display_label": "Recruiter",
            "share_with_peers": false,
            "name": "Recruiter",
            "id": "486812000000071955",
            "reporting_to": {
                "name": "Recruiter Admin",
                "id": "486812000000071953"
            }
        },
        {
            "display_label": "Client Administrator",
            "share_with_peers": true,
            "name": "Client Administrator",
            "id": "486812000001121001",
            "reporting_to": null
        },
        {
            "display_label": "Client Interviewer",
            "share_with_peers": false,
            "name": "Client Interviewer",
            "id": "486812000001121003",
            "reporting_to": {
                "name": "Client Administrator",
                "id": "486812000001121001"
            }
        }
    ]
}