Specific Custom View Meta Data
Purpose
To get the data of any specific custom view of the module. Specify the custom view ID of the module in your API request whose custom view data you want to retrieve.
Request URL
https://www.zohoapis.com/crm/v2/settings/custom_views/{custom_view_id}
custom_view_id - The unique ID of the custom view
Request Method
GET
Scope
scope=ZohoCRM.settings.custom_views.read
(or)
scope=ZohoCRM.settings.custom_views.all
(or)
scope=ZohoCRM.settings.all
Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| module (mandatory) | String | Specify the API name of the required module. For example, Leads, Contacts, Accounts, Deals, 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
Copied"https://www.zohoapis.com/crm/v2/settings/custom_views/4108880000066613?module=Leads"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedZCRMModule module = ZCRMModule.getInstance("Contacts");
APIResponse response = module.getCustomView(98658369836l);
ZCRMCustomView customView = (ZCRMCustomView) response.getData(); Copied$zcrmModuleIns = ZCRMModule::getInstance("Products");
$apiResponse=$zcrmModuleIns->getCustomView(410405000005108011);//custom view ID
$zcrmCustomView=$apiResponse->getData(); // Here $zcrmCustomView is an instance of ZCRMCustomViewCopied def get_customview(self):
try:
module_ins = ZCRMModule.get_instance('Accounts') # module API Name
resp = module_ins.get_customview(3719520000000087515) # CUSTOM VIEW ID
print(resp.status_code)
cv_ins_arr = [resp.data]
for customview_ins in cv_ins_arr:
print("\n\n:::CUSTOM VIEW DETAILS:::")
print(customview_ins.id)
print(customview_ins.module_api_name)
print(customview_ins.display_value)
print(customview_ins.is_default)
print(customview_ins.name)
print(customview_ins.system_name)
print(customview_ins.sort_by)
print(customview_ins.category)
fields = customview_ins.fields
print("\n:::FIELDS:::")
for field in fields:
print(field)
print(customview_ins.favorite)
print(customview_ins.sort_order)
cv_criteria = customview_ins.criteria
if cv_criteria is not None:
print("\n\n :::CRITERIA::::")
for criteria_ins in cv_criteria:
print(criteria_ins.field)
print(criteria_ins.comparator)
print(criteria_ins.value)
print(customview_ins.criteria_pattern)
categories = customview_ins.categories
print("\n\n :::CATEGORIES::::")
if categories is not None:
for category in categories:
print(category.actual_value)
print(category.display_value)
print(customview_ins.is_off_line)
except ZCRMException as ex:
print(ex.status_code)
print(ex.error_message)
print(ex.error_code)
print(ex.error_details)
print(ex.error_content)CopiedZCRMModule moduleIns = ZCRMModule.GetInstance("Leads"); //module api name
APIResponse response = moduleIns.GetCustomView(33721640000006); //33721640000006 is customView id
ZCRMCustomView customView = (ZCRMCustomView)response.Data;Sample Response
Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Sample Response
Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Sample Response
Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Sample Response
Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}Copied{
"custom_views": [
{
"display_value": "Email Opt Out",
"shared_type": "only_me",
"criteria": {
"comparator": "equal",
"field": "Email_Opt_Out",
"value": true
},
"system_name": null,
"shared_details": null,
"sort_by": null,
"offline": true,
"default": true,
"system_defined": false,
"name": "Email Opt Out",
"id": "3652397000000538003",
"category": "created_by_me",
"fields": [
"First_Name",
"Last_Name",
"Company",
"Email",
"Email_Opt_Out"
],
"favorite": null,
"sort_order": null
}
],
"info": {
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
}
}
}