Get Custom Views

Purpose

To get the custom view data of a specific module using Widget APIs.

Request Format

ZOHO.RECRUIT.META.getCustomViews
({
"Entity": "{module_api_name}"
})

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.

Sample Request (Get all Custom Views)

CopiedZOHO.RECRUIT.META.getCustomViews({
    "Entity": "Candidates"
}).then(function(successResponse) {
    
}, function(errorResponse) {
    
});

Sample Request (Get specific Custom Views)

CopiedZOHO.RECRUIT.META.getCustomViews({
    "Entity": "Candidates",
    "ID": "14501000000119158"
}).then(function(successResponse) {
   
}, function(errorResponse) {
    
});

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