Modules APIs
Zoho Recruit has standard modules such as Candidates, Job Openings, Contacts, Interviews, Reports, Assessments, etc. Using Zoho Recruit's REST API, you can retrieve the list of available modules as shown in the examples below:
Get list of modules
Purpose
To get the module related data. This will retrieve the list of modules available in your Zoho Recruit account.
Request URL
https://recruit.zoho.com/recruit/v2/settings/modules
To get a specific module;
https://recruit.zoho.com/recruit/v2/settings/modules/{module_api_name}
Request Method
GET
Scope
scope=ZohoRecruit.setup.operation.all
(or)
scope=ZohoRecruit.setup.operation.{operation_type}
| Possible operation types |
|---|
| ALL - Full data access READ - Get module data |
Attributes
"convertable": Describes if the user can convert the record into another type of record. For example: Convert Candidates into Contacts.
"creatable": Checks if the user can create a record in the current module.
"generated_type": Describes the type of module which would be generated by the user. There are 4 types: default, web, custom, and linking.
"api_supported": The modules which are currently not accessible by APIs have value as "false". If the modules are supported in the future, the value automatically changes to "true".
"modified_time": The date and time at which the user has made a change.
Refer to the key api_name in the JSON data while accessing the resource. Every module, field, and the related list will have an API name, which you can use in third-party integrations. For example, if you want to access the Candidates module, use “Candidates" as the api_name every time you access the resource. Zoho Recruit generates API names internally while creating a custom module, custom field, or related list label. Please note that you cannot alter the API Names for the default modules, fields, and related lists. You can change the API names only for custom modules, fields, and related lists.
The generated API name can contain only alphabets, numbers, and underscore. The API name should start with an alphabet and should not have two consecutive underscores or end with an underscore.
Refer Response Structure for more details about the JSON keys, values, and their descriptions of the available modules. You can also use the sample response of each module as the input when you insert, update, or upsert a record in that corresponding module.
Sample Request
Copied curl "https://recruit.zoho.com/recruit/v2/settings/modules"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"Sample Response
Copied{
"modules": [
{
"global_search_supported": false,
"deletable": false,
"creatable": false,
"modified_time": null,
"plural_label": "Home",
"presence_sub_menu": false,
"id": "100001000000002511",
"convertable": false,
"editable": false,
"emailTemplate_support": false,
"profiles": [
{
"name": "Administrator",
"id": "100001000000017723"
},
{
"name": "Standard",
"id": "100001000000017726"
},
{
"name": "Guest",
"id": "100001000000017729"
},
{
"name": "Interviewer",
"id": "100001000000017732"
},
{
"name": "Client Administrator",
"id": "100001000000021138"
},
{
"name": "Client Interviewer",
"id": "100001000000021459"
}
],
"filter_supported": false,
"display_field": null,
"web_link": null,
"sequence_number": 1,
"singular_label": "Home",
"viewable": true,
"api_supported": false,
"api_name": "Home",
"quick_create": false,
"modified_by": null,
"generated_type": "default",
"scoring_supported": false,
"module_name": "Home",
"parent_module": {}
},
{
"global_search_supported": true,
"deletable": true,
"creatable": true,
"modified_time": null,
"plural_label": "Job Openings",
"presence_sub_menu": true,
"id": "100001000000002521",
"convertable": false,
"editable": true,
"emailTemplate_support": true,
"profiles": [
{
"name": "Administrator",
"id": "100001000000017723"
},
{
"name": "Standard",
"id": "100001000000017726"
},
{
"name": "Guest",
"id": "100001000000017729"
},
{
"name": "Interviewer",
"id": "100001000000017732"
},
{
"name": "Client Administrator",
"id": "100001000000021138"
},
{
"name": "Client Interviewer",
"id": "100001000000021459"
}
],
"filter_supported": true,
"display_field": "Potential_Name",
"web_link": null,
"sequence_number": 2,
"singular_label": "Job Opening",
"viewable": true,
"api_supported": true,
"api_name": "Job_Openings",
"quick_create": true,
"modified_by": null,
"generated_type": "default",
"scoring_supported": true,
"module_name": "Potentials",
"parent_module": {}
},
{
"global_search_supported": true,
"deletable": true,
"creatable": true,
"modified_time": "2020-03-08T23:16:45+05:30",
"plural_label": "Candidates",
"presence_sub_menu": true,
"id": "100001000000002515",
"convertable": true,
"editable": true,
"emailTemplate_support": true,
"profiles": [
{
"name": "Administrator",
"id": "100001000000017723"
},
{
"name": "Standard",
"id": "100001000000017726"
},
{
"name": "Guest",
"id": "100001000000017729"
},
{
"name": "Interviewer",
"id": "100001000000017732"
},
{
"name": "Client Administrator",
"id": "100001000000021138"
},
{
"name": "Client Interviewer",
"id": "100001000000021459"
}
],
"filter_supported": true,
"display_field": "Full_Name",
"web_link": null,
"sequence_number": 3,
"singular_label": "Candidate",
"viewable": true,
"api_supported": true,
"api_name": "Candidates",
"quick_create": true,
"modified_by": {
"name": "Vignesh MPG",
"id": "100001000000020618"
},
"generated_type": "default",
"scoring_supported": true,
"module_name": "Candidates",
"parent_module": {}
}
]
}