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://workerly.zoho.com/workerly/v2/settings/custom_views/{module_id}?module={module_api_name}

module_api_name - The API name of the module
module_id - The unique Id of the module

Request Method

GET

Scope

scope=ZohoWorkerly.settings.custom_views.read
(or)
scope=ZohoWorkerly.settings.custom_views.all
(or)
scope=ZohoWorkerly.settings.all

Parameters

Parameter Name	Data Type	Description
module (mandatory)	String	Specify the API name of the required module. For example, Temps, Contacts, Clients, and so on.

Possible Errors

HTTP Status	Error Code	Message	Reason
400	INVALID_MODULE	The module name given is 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

Copiedhttps://workerly.zoho.com/workerly/v2/settings/custom_views/15304000000012539?module=Temps

Sample Response

Copied{
    "custom_views": [
        {
            "display_value": "Inactive Temps",
            "shared_type": null,
            "criteria": {
                "comparator": "equal",
                "field": "Temp_Status",
                "value": "Inactive"
            },
            "system_name": "INACTIVELEADS",
            "shared_details": null,
            "sort_by": null,
            "offline": true,
            "default": false,
            "system_defined": true,
            "name": "Inactive Temps",
            "id": "15304000000012539",
            "category": "shared_with_me",
            "fields": [
                "First_Name",
                "Last_Name",
                "Current_Title",
                "Skill_Set",
                "Temp_Owner",
                "Base_Pay_Rate_Per_Hour",
                "City"
            ],
            "favorite": null,
            "sort_order": null,
            "is_search": false
        }
    ]
}