Custom Views Meta Data
Purpose
To get the custom views data of a particular module.
Request Details
Request URL
{api-domain}/crm/{version}/settings/custom_views?module={module_api_name}
Supported modules
Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Custom, and Activities
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.custom_views.READ
(or)
scope=ZohoCRM.settings.custom_views.ALL
(or)
scope=ZohoCRM.settings.ALL
Parameters
- modulestring, mandatory
Specify the API name of the required module. For example, Leads, Contacts, Accounts, Deals, and so on.
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v2.1/settings/custom_views?module=Leads"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Copied//Get instance of CustomViewOperations Class that takes moduleAPIName as parameter
$customViewsOperations = new CustomViewsOperations($moduleAPIName);
//Call getCustomViews method
$response = $customViewsOperations->getCustomViews();Copiedcvo = CustomViews::CustomViewsOperations.new(module_api_name)
# Get instance of ParameterMap Class
pm = ParameterMap.new
# Call get_custom_views method
response = cvo.get_custom_views(pm)Response JSON Keys
- display_valuestring
Represents the display name of the current custom view.
- defaultboolean
Represents if the current custom view is the default one.
true: The current custom view is the default one.
false: The current custom view is not the default one. - modified_timeDateTime in ISO 8601 format
Represents the date and time at which the custom view was modified. The value of this key will be null when custom view was not modified.
- system_namestring
Represents the system reference name of the current custom view.
- system_definedboolean
Represents if the current custom view is a system-defined view.
true: The current custom view is system-defined.
false: The current custom view is not system-defined. - namestring
Represents the name of the current custom view.
- modified_byJSON object
Represents the name and ID of the user that modified the custom view. The value of this key will be null when custom view was not modified.
- idstring
Represents the unique ID of the current custom view.
- categorystring
Represents the category of the current custom view. The value can be: public_views, other_users_views, shared_with_me, or created_by_me.
- last_accessed_timeDateTime in ISO 8601 format
Represents the date and time at which the custom view was last accessed. The value of this key will be null until the custom view is accessed.
- favoriteinteger
Represents if the current custom view is marked as favorite.
- created_byJSON object
Represents the name and ID of the user that created the custom view. The value of this key will be null for a system-defined custom view.
Note
- The display values of keys related to Events will be Meetings.
- While fetching a specific custom view,
- shared_type is renamed as access_type.
- shared_details is renamed as shared_to.
- shared_to is rendered in the response only for those custom views with "access_type":"shared".
Possible Errors
- REQUIRED_PARAM_MISSINGHTTP 400
Bad Request
Resolution: You have not specified the mandatory parameter. Refer to parameters section above. - INVALID_MODULEHTTP 400
The module name given seems to be invalid
Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name. - INVALID_MODULEHTTP 400
The given module is not supported in API
Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name. - INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.settings.custom_views.READ scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to read
Resolution: The user does not have permission to read custom view data. Contact your system administrator. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team. - INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above. - AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to read custom views data
Resolution: The user does not have the permission to retrieve custom views data. Contact your system administrator.
Sample Response
Copied{
"custom_views": [
{
"display_value": "All Leads",
"default": true,
"modified_time": "2020-04-13T11:52:02+05:30",
"system_name": "ALLVIEWS",
"name": "All Open Leads",
"system_defined": true,
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"id": "3652397000000087501",
"category": "public_views",
"last_accessed_time": "2021-02-26T12:41:51+05:30",
"favorite": null,
"created_by": null
},
{
"display_value": "Co-Owner Leads",
"default": false,
"modified_time": "2019-05-09T11:39:20+05:30",
"system_name": "COOWNERVIEW",
"name": "Co-Owner Leads",
"system_defined": true,
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000281001"
},
"id": "3652397000000747007",
"category": "public_views",
"last_accessed_time": "2019-05-09T11:37:15+05:30",
"favorite": null,
"created_by": null
},
{
"display_value": "Converted Leads",
"default": false,
"modified_time": null,
"system_name": "CONVERTEDVIEWS",
"name": "Converted Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000089005",
"category": "public_views",
"last_accessed_time": "2019-01-02T15:03:05+05:30",
"favorite": null,
"created_by": null
},
{
"display_value": "Email Opt Out",
"default": false,
"modified_time": "2019-02-19T12:03:07+05:30",
"system_name": null,
"name": "Email Opt Out",
"system_defined": false,
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"id": "3652397000000538003",
"category": "created_by_me",
"last_accessed_time": "2019-04-10T10:54:55+05:30",
"favorite": null,
"created_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
}
},
{
"display_value": "Junk Leads",
"default": false,
"modified_time": null,
"system_name": "JUNKLEADVIEWS",
"name": "Junk Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000149020",
"category": "public_views",
"last_accessed_time": "2019-12-31T15:52:00+05:30",
"favorite": null,
"created_by": null
},
{
"display_value": "Leads in Review",
"default": false,
"modified_time": null,
"system_name": "REVIEWPROCESS LEADS",
"name": "Leads in Review",
"system_defined": true,
"modified_by": null,
"id": "3652397000001424014",
"category": "public_views",
"last_accessed_time": null,
"favorite": null,
"created_by": null
},
{
"display_value": "Mailing Labels",
"default": false,
"modified_time": null,
"system_name": "ALLVIEWS",
"name": "Mailing Labels",
"system_defined": true,
"modified_by": null,
"id": "3652397000000087503",
"category": "public_views",
"last_accessed_time": null,
"favorite": null,
"created_by": null
},
{
"display_value": "Leads Shared by Me",
"default": false,
"modified_time": null,
"system_name": "LEADSSHAREDBYME",
"name": "Module Shared by Me",
"system_defined": true,
"modified_by": null,
"id": "3652397000001615027",
"category": "public_views",
"last_accessed_time": null,
"favorite": null,
"created_by": null
},
{
"display_value": "Leads Shared to Me",
"default": false,
"modified_time": null,
"system_name": "LEADSSHAREDTOME",
"name": "Module Shared to Me",
"system_defined": true,
"modified_by": null,
"id": "3652397000001615021",
"category": "public_views",
"last_accessed_time": null,
"favorite": null,
"created_by": null
},
{
"display_value": "My Converted Leads",
"default": false,
"modified_time": null,
"system_name": "MYCONVERTEDVIEWS",
"name": "My Converted Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000089007",
"category": "public_views",
"last_accessed_time": null,
"favorite": null,
"created_by": null
},
{
"display_value": "My Leads",
"default": false,
"modified_time": null,
"system_name": "MYVIEWS",
"name": "My Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000087563",
"category": "public_views",
"last_accessed_time": "2021-02-16T14:45:44+05:30",
"favorite": null,
"created_by": null
},
{
"display_value": "Not Qualified Leads",
"default": false,
"modified_time": null,
"system_name": "NOTQUALIFIEDLEADVIEWS",
"name": "Not Qualified Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000149031",
"category": "public_views",
"last_accessed_time": null,
"favorite": null,
"created_by": null
},
{
"display_value": "Open Leads",
"default": false,
"modified_time": null,
"system_name": "OPENLEADVIEWS",
"name": "Open Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000149042",
"category": "public_views",
"last_accessed_time": null,
"favorite": null,
"created_by": null
},
{
"display_value": "Recently Created Leads",
"default": false,
"modified_time": null,
"system_name": "RECENTLYCREATED",
"name": "Recently Created Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000087509",
"category": "public_views",
"last_accessed_time": null,
"favorite": null,
"created_by": null
},
{
"display_value": "Recently Modified Leads",
"default": false,
"modified_time": null,
"system_name": "RECENTLYMODIFIED",
"name": "Recently Modified Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000087511",
"category": "public_views",
"last_accessed_time": null,
"favorite": null,
"created_by": null
},
{
"display_value": "Today's Leads",
"default": false,
"modified_time": null,
"system_name": "today",
"name": "Todays Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000087507",
"category": "public_views",
"last_accessed_time": "2019-03-21T17:51:43+05:30",
"favorite": null,
"created_by": null
},
{
"display_value": "Unread Leads",
"default": false,
"modified_time": null,
"system_name": "UNREADVIEWS",
"name": "Unread Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000000087505",
"category": "public_views",
"last_accessed_time": null,
"favorite": null,
"created_by": null
},
{
"display_value": "Unsubscribed Leads",
"default": false,
"modified_time": null,
"system_name": "UNSUBSCRIBED",
"name": "Unsubscribed Leads",
"system_defined": true,
"modified_by": null,
"id": "3652397000002569003",
"category": "public_views",
"last_accessed_time": null,
"favorite": null,
"created_by": null
},
{
"display_value": "Untitled View",
"default": false,
"modified_time": "2019-12-20T13:39:58+05:30",
"system_name": null,
"name": "Untitled View",
"system_defined": false,
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"id": "3652397000001459041",
"category": "created_by_me",
"last_accessed_time": "2019-12-31T15:51:43+05:30",
"favorite": null,
"created_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
}
},
{
"display_value": "Untitled View1",
"default": false,
"modified_time": "2020-01-16T10:40:17+05:30",
"system_name": null,
"name": "Untitled View1",
"system_defined": false,
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"id": "3652397000001592009",
"category": "created_by_me",
"last_accessed_time": "2020-01-28T17:20:45+05:30",
"favorite": null,
"created_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
}
}
],
"info": {
"per_page": 20,
"default": "3652397000000087501",
"count": 20,
"translation": {
"public_views": "Public Views",
"other_users_views": "Other Users' Views",
"shared_with_me": "Shared With Me",
"created_by_me": "Created By Me"
},
"page": 1,
"more_records": false
}
}