Custom Views Meta Data
Purpose
To get the custom views data of a particular module. Specify the module name in your API request whose custom view data you want to retrieve.
Request URL
https://recruit.zoho.com/recruit/v2/settings/custom_views?module={module_api_name}
To get a specific custom view from a module,
https://recruit.zoho.com/recruit/v2/settings/custom_views/{custom_view_id}?module={module_api_name}
module_api_name - The API name of the module
custom_view_id - The unique ID of the custom view
Request Method
GET
Scope
scope=ZohoRecruit.settings.custom_views.read
(or)
scope=ZohoRecruit.settings.custom_views.all
(or)
scope=ZohoRecruit.settings.all
| Possible module names | Possible Operation Types |
|---|---|
candidate, jobopenings, interview, client, contact, department, task, event, vendor, campaign, referral, review, submission, and custommodule | ALL - Full access to custom view data |
Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| module (mandatory) | String | Specify the API name of the required module. For example, Candidates, Contacts, Clients, Interviews, and so on. |
Possible Errors
| HTTP Status | Error Code | Message | Reason |
|---|---|---|---|
| 400 | INVALID_MODULE | The module name given seems to be invalid | Invalid module name or no tab permission, or the module could have been removed from the organized module |
| 400 | INVALID_MODULE | The given module is not supported in API | The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are supported.) |
Sample Request
Copiedcurl "https://recruit.zoho.com/recruit/v2/settings/custom_views/486812000000112160?module=Candidates"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Sample Response
Copied{
"custom_views": [
{
"display_value": "All Candidates",
"created_time": null,
"system_name": "ALLVIEWS",
"description": "List of all Candidates in your account.",
"sort_by": null,
"created_by": null,
"offline": true,
"default": true,
"modified_time": "2024-08-09T04:26:24+05:30",
"modified_by": {
"name": "Candidate Name",
"id": "100000000000014"
},
"system_defined": true,
"name": "All Open Leads",
"id": "100000000000004",
"locked": false,
"category": "shared_with_me",
"favorite": null,
"sort_order": null,
"is_search": false
}
]
}
