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 READ - Read 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",
            "shared_type": null,
            "criteria": null,
            "system_name": "ALLVIEWS",
            "shared_details": null,
            "sort_by": "Updated_On",
            "offline": true,
            "default": false,
            "system_defined": true,
            "name": "All Open Leads",
            "id": "486812000000112160",
            "category": "shared_with_me",
            "fields": [
                "First_Name",
                "Last_Name",
                "City",
                "Candidate_Status",
                "Updated_On",
                "Source",
                "Email",
                "Current_Salary"
            ],
            "favorite": null,
            "sort_order": "desc",
            "is_search": false
        }
    ]
}