Kaizen #183 - COQL API's Enhancements in Zoho CRM API Version 7

Hello everybody!

Welcome back to another post in our Kaizen series.

In this post, we will discuss the latest COQL API enhancements introduced in Zoho CRM Version 7.

COQL API

Query API lets you query for records based on queries using the CRM Object Query Language(COQL). COQL is based on the SQL query syntax, and supports the SELECT query to fetch records. Using this API, you can query for data across different modules that are linked using lookup fields. 

1. Enhanced Field Limits in the SELECT Clause

You can now retrieve up to 500 fields in a single query. Previously, the limit was 50. This allows you to fetch more data in a single request, reducing the number of API calls and improving performance.

Sample query:

{   "select_query": "select Last_Name, Email, Phone, Industry, Revenue, ... (500 fields) from Leads where id is not null" }

2. Enhanced Value Limits for IN and NOT IN Operators

The IN and NOT IN operators now support up to 100 values each, doubling the previous limit of 50. This enhancement allows for more comprehensive filtering in your queries. Users can now include a larger set of criteria in a single query, making it easier to retrieve your data without needing multiple queries.

Sample query for IN:

{   "select_query": "select Account_Name from Accounts where Industry in ('IT', 'Finance', 'Healthcare', ... (100 values))" }

Sample query for NOT IN:

{   "select_query": "select Account_Name from Accounts where Industry not in ('IT', 'Finance', 'Healthcare', ... (100 values))" }

3. Custom View support in COQL API

No more manual filtering! Simply use a custom view ID directly in the FROM clause. Retrieve custom view IDs using the Custom View API and include them in your queries to retrieve specific-custom view data.

Unsupported Custom Views

• Custom View in Other Modules : The following custom views are not supported in any module.
• Shared By Me
• Co-owner
• Shared To Me

In the Custom View API response for a module (e.g., Leads), search for the key "system_name". If the value matches any of the unsupported custom views (Shared By Me, Co-owner, Shared To Me), that view is not supported.

Example : Shared By Me

Key and Value Structure	"system_name": "{module_name}SHAREDBYME"
Example	"system_name": "LEADSSHAREDBYME"

COQL supports CVID in the following format: FROM {module_API_name}#{CVID}. 

See the sample query below for reference.

Sample query:

{     "select_query": "select Lead_Status from Leads#5725767000000087501 WHERE id is not null" } //CVID: 5725767000000087501 - This is the Custom View ID in the Leads module.

4. Retrieve Corresponding Field Metadata via COQL

Need to retrieve field details? You can fetch both the required data and field metadata in a single query. Just add "include_meta" key to your query to retrieve field metadata. This key fetches metadata for the fields specified only in the SELECT column. Also, it eliminates making an additional GET - Fields Metadata API call to know the field metadata and save API credits.

Sample query:

{     "select_query": "select Lead_Status, Phone from Leads where id is not null",     "include_meta": [         "fields"     ] }

Ensure you have the ZohoCRM.settings.fields.READ scope to avoid an OAUTH_SCOPE_MISMATCH error.

Sample Response:

{     "data": [         {             "Lead_Status": "Attempted to Contact",             "Phone": "555-555-5555",             "id": "5725767000000420480"         },         {             "Lead_Status": "Contact in Future",             "Phone": "555-555-5555",             "id": "5725767000000420481"         },         .         .         .              ],     "fields": {         "Lead_Status": {             "webhook": true,             "operation_type": {                 "web_update": true,                 "api_create": true,                 "web_create": true,                 "api_update": true             },             "colour_code_enabled_by_system": false,             "field_label": "Lead Status",             "tooltip": null,             "type": "used",             "table_name": "CrmLeadDetails",             "field_read_only": false,             "required": false,             "display_label": "Lead Status",             "read_only": false,             "association_details": null,             "multi_module_lookup": {},             "id": "5725767000000002611",             "created_time": null,             "filterable": true,             "visible": true,             "refer_from_field": null              "auto_number": {}         }     },     "info": {         "count": 200,         "more_records": true     } }

5. Field Limit Restriction in the ORDER BY Clause

The fields limit has been restricted in the ORDER BY clause. You can specify up to 10 fields in the ORDER BY clause for more precise sorting. Previously, there was no limit. This restriction helps improve query performance.

sample query:

{     "select_query" : "select Last_Name from Leads where id is not null order by Lead_Source, Lead_Status, Email, ... (up to 10 fields)" }

6. Duplicate fields restriction 

Duplicate fields are restricted in ORDER BY, GROUP BY, and AGGREGATE clauses. That is, if the same field is specified multiple times within the same clause, leading to unnecessary repetition and potential errors. This ensures cleaner and more accurate query results. Previously, this restriction applied only to the SELECT column. 

Bad query:

{ "select_query":"select id from Contacts where id is not null order by id,id" }

Duplicate aggregate fields in a query will result in a "DUPLICATE_DATA" error in the response.

7. Retrieve territory information

You can now retrieve territory information from a module by including the territory field API name in the SELECT column. This is useful to understand where your data has been distributed in various geographical locations.

Sample query 1 :

{   "select_query": "select Account_Name, Territories from Accounts where id is not null" }

Sample query 2 :

{  "select_query" : "select Territories, Account_Name.Territories from Contacts where id is not null"  }

Sample response:

{     "data": [         {             "Account_Name.Territories": [                 {                     "name": "USA",                     "id": "5725767000000454003"                 }             ],             "id": "5725767000000420261",             "Territories": [                 {                     "name": "China",                     "id": "5725767000000454981"                 }             ]         },         .         .         .             ],     "info": {         "count": 174,         "more_records": false     } }

Supported modules to retrieve territory details: Contacts, Accounts, Leads, and Deals.

Note: 

The territory field API names differ by module:

• Accounts, Contacts, and Leads : Territories
• Deals : Territory
  

8. "Full_Name" retrieval based on user preferences 

The full name can be retrieved based on the current user's display name pattern, as set in their preferences. This ensures that the full name format aligns with the user's settings.

The "Full_Name" field contains the concatenated values of the First_Name and Last_Name fields. This is a read-only field available only in the Leads and Contacts modules.

Sample query:

{     "select_query": "select Full_Name from Contacts where id is not null" }

9. Support for Multiple Modules in "what_id"

A Multi-Module Lookup (MML) field is a special type of lookup field that allows you to establish a relationship between a record in one module and records from multiple other modules. Unlike a standard lookup field that references a single module, an MML field can point to multiple module types.

Currently, an MML field is available in the Appointments module. The Appointment_For field is an MML field that can reference multiple modules, such as Leads and Contacts.

Sample query:

{  "select_query": "select 'What_Id->Leads.Company','What_Id->Accounts.Account_Type' from Calls where id is not null" }

9.1 Support to query Multi-module Lookup (MML)'s inner field

You can now retrieve inner fields of linked modules within the MML field. This provides deeper insights into related fields data in a module. 

For example, you can now query specific fields from a related module that is linked through a Multi-Module Lookup, making your data retrieval more precise and informative. 

{  "select_query": "select 'Appointment_For->Contacts.Lead_Source' from Appointments__s where id is not null" }

This query retrieves the Lead Source field from the Contacts module within the Appointment_For MML field. 

9.2 Support for Querying Multi-Module Lookup Module Name

Retrieve the module name associated with each record in a Multi-Module Lookup (MML) field. This helps in identifying the source module of the linked records, providing a better context for your data.

Sample query:

{ "select_query": "select Appointment_For.module.api_name, Appointment_For from Appointments__s where id is not null" }

The Appointment_For.module.api_name returns the module name (e.g., Contacts or Accounts) for each record linked in the Appointment_For MML field.

10. Retrieving Consent-Related Information

You can now retrieve consent-related information using the Consents Lookup fields in a module. This is particularly useful for GDPR compliance, ensuring you have consent records.

For more details, refer to the Consent Management documentation. This is particularly useful for GDPR compliance, ensuring you have all necessary consent information.

Note:

• Once GDPR is enabled and configured for a module, a new Data Processing Basis Details field will be created in the respective module with the data type consent_lookup ("data_type": "consent_lookup").
• You can retrieve the Data Processing Basis Details field created in the module using the GET Fields Metadata API. 
• To know all available fields in the Consents module, make another GET Fields Metadata API call.
  

Sample query:

{ "select_query": "select Data_Processing_Basis_Details.Contact_Through_Survey, Data_Processing_Basis_Details.Data_Processing_Basis from Leads where Data_Processing_Basis_Details is not null" }

11. Enhanced Lookup Field Response 

Previously, when a lookup field was included in the SELECT column JOIN, only the lookup field’s ID was displayed. From V7, the corresponding display field value is also provided. Now, when you specify a lookup field in the SELECT column, the response includes the id of the Lookup record ID and the display field value of the lookup record. 

This eliminates the need for an additional SELECT column JOIN to fetch the display value (e.g., Owner.last_name).

Sample query:

{ "select_query" : "select Owner from Accounts where id is not null" }

Sample response

V6

V7

{     "data": [         {             "Owner": {                 "id": "5725767000000411001"             },             "id": "5725767000000420169"         },         {             "Owner": {                 "id": "5725767000000411001"             },             "id": "5725767000000420170"         },         .         .         .     ],     "info": {         "count": 23,         "more_records": false     } }

{     "data": [         {             "Owner": {                 "name": "Boyle",                 "id": "5725767000000411001"             },             "id": "5725767000000420169"         },         {             "Owner": {                 "name": "Kate",                 "id": "5725767000000411482"             },             "id": "5725767000000420170"         },         .         .         .     ],     "info": {         "count": 23,         "more_records": false     } }

Note:

• If you query the Users lookup field in the SELECT column, the corresponding record’s last name (display field) will be displayed in the name key of the corresponding lookup JSON (e.g. Owner) response, from V7. 
• Display field value will not be available for Consent Lookup and Multi-Module Lookup (MML) fields.
  

12. Increasing "Profile Image" field comparators

The Profile Image field now supports additional comparators.

V6	V7
is null, is not null	is null, is not null, =, !=, in, not in, like, not like

You can use a record image's ID to fetch related data. For example, if you only have a record image's ID and want to retrieve the respective record's last name, you can include the record image ID in your query. 

Refer to the COQL document for more details.

Sample query:

{  "select_query" : "select Record_Image from Leads where Record_Image = 'siwz79472749456ff433f8b88d0a795ae9855' "  }

13. Enhanced "Rollup Summary" field comparators

The Rollup Summary field now supports additional comparators, making it easier to filter and analyze your data with more precision.

V6	V7
is null, is not null	=, !=, >=, >, <=, <, between, not between, in, not in, is null, is not null

Sample query:

{  "select_query" : "select Last_Name from Leads where Total_Calls between 5 and 10" }

13.1 Enhanced response for the Date and Datetime return types of the Rollup Summary 

The Date and Datetime return types in the Rollup Summary field are now provided in ISO date and ISO datetime formats based on the user's time zone.

Sample query:

{ "select_query": "select Last_Note_Added from Leads where id is not null" }

Response

V6	V7
{     "data": [                  {             "Last_Note_Added": "1721302770000",             "id": "5725767000003160016"         },         .         .         .              ],     "info": {         "count": 200,         "more_records": true     } }	{     "data": [                  {              "Last_Note_Added": "2024-07-04T03:49:48-07:00",             "id": "5725767000003160016"         },         .         .         .              ],     "info": {         "count": 200,         "more_records": true     } }

14. Enhanced LIMIT and OFFSET Value Limit

You can now retrieve up to 100,000 records using pagination with the LIMIT and OFFSET clauses. This significantly increases the amount of data you can handle in a single query, making it easier to work with large datasets. Previously, the maximum limit was 10,000. For the next set of records, add another criteria id > {1,00,000th record ID} with the "AND" operator, and go on to fetch the next 1,00,000 records.

Sample query:

{ "select_query" : "select Last_Name, Created_Time from Leads where (Last_Name is not null and id > 5725767000003160016)" }

15. Enhanced JOIN Support Limit

Base Column JOIN

If a query contains any lookup_field.{any_field} in any clause other than the SELECT column such as ORDER BY, GROUP BY, or AGGREGATE columns, then it will be treated as Base JOIN. The Base JOIN support limit has been increased from two to five. This enhancement enables more complex queries across multiple modules, improving data retrieval flexibility.

Sample query: 

{  "select_query" : "select id from Contacts where id is not null order by Owner.role, Created_By.profile" }

Refer to the Base JOIN section in the COQL API document for more details. 

15.1 Introducing the SELECT Column JOIN

A new SELECT column JOIN has been introduced, with a maximum limit of 15.

Advantages of SELECT Column JOIN

• If a lookup field is included in the SELECT column and another lookup field is used in the Base column JOIN, they will be treated as separate JOINs. This ensures that the SELECT column JOIN does not affect the Base JOIN.
• Previously, when two lookup fields in the SELECT pointed to the same module (e.g., Users), they were treated as separate JOINs. From V7, they are now considered a single JOIN, optimizing query performance and reducing redundancy.
  
  

Sample query:

{ "select_query" : "select Owner.last_name, Created_By.role from Contacts where id is not null" }

Refer to the JOINs in COQL Queries for more details on both the JOINs.

16. Subquery in COQL

A subquery support has been given in COQL. A subquery is a child query that is nested or embedded within a parent query i.e., outer query. Subqueries can be used as an alternative to JOINs in a query. Use subqueries when a JOIN field is only needed in the criteria, i.e., in the WHERE clause. The primary reason for using subqueries is to improve performance by saving time and memory.  

Sample query:

{ "select_query" : "select Lead_Source,Email from Leads where Contacts in (select id from Contacts where Email='patricia@mail.com')" }

You can retrieve up to 100 records per subquery in a single query. A maximum of 5 subqueries can be queried in a parent query. 

Refer to the Subquery documentation for more details. A detailed post on Subquery will be covered in an upcoming Kaizen post.

We trust that this post meets your needs and is helpful. Let us know your thoughts in the comment section or reach out to us at support@zohocrm.com.

Stay tuned for more insights in our upcoming Kaizen posts! 

Happy querying!

Previous Kaizen: Kaizen #182 - Queries in Canvas List View | Kaizen Directory

• Topic Participants

• Subramanian K

  

• Sticky Posts

• Kaizen #217 - Actions APIs : Tasks

  Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.

• Kaizen #216 - Actions APIs : Email Notifications

  Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes are

• Kaizen #152 - Client Script Support for the new Canvas Record Forms

  Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achieved

• Kaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script

  Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.

• Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI

  Hello Everyone, Welcome back to yet another post in the Kaizen Series! As you already may know, for the Kaizen #200 milestone, we asked for your feedback and many of you suggested topics for us to discuss. We have been writing on these topics over the

• Recent Topics

• Calls undetected.

  The call is not showing on the call log.

• Calls undetected

  Zoho is not reading calls made.

• Multi-currency and Products

  One of the main reasons I have gone down the Zoho route is because I need multi-currency support.  However, I find that products can only be priced in the home currency, We sell to the US and UK.  However, we maintain different price lists for each. 

• Missing information data Zoho inventory

  there some missing data in Zoho inventory connection. pick list stock counts bin location we have requested it via mail and the support team doesn’t gove feedback. has anyone achieve to get these info or to ask other ya les

• Calendar Events Issues

  Not able to view scheduled events on my calendar

• Your Incoming has been blocked and the emails will not be fetched in your Zoho account and POP Accounts

  Can some on help me regarding our account . thank you so much

• Extensions 101 webinar series: Build, integrate, and monetize with extensions

  Attention developers! Are you ready to take your extension development skills to the next level? We're excited to bring back the Extensions 101 webinar series with an expanded lineup of Zoho products and an introduction to more platform features. Last

• Custom Related List Inside Zoho Books

  Hello, We can create the Related list inside the zoho books by the deluge code, I am sharing the reference code Please have a look may be it will help you. //..........Get Org Details organizationID = organization.get("organization_id"); Recordid = cm_g_a_data.get("module_record_id");

• Where are recordings stored?

  I have hosted a couple of test meeting, used the "record" button to start and stop the recording but I am unable to find where are those recordings saved?  Can anybody help? Thanks

• Zoho Desk's integration with Microsoft PowerBI delivers advanced analytics insights

  Hello everyone, Gaining advanced insights through reports and dashboards is one of the critical requirements of every business. In addition to key metrics tracked in Zoho Desk, such as agent performance, SLA adherence, and ticket lifecycle, businesses

• Create static subforms in Zoho CRM: streamline data entry with pre-defined values

  Last modified on (9 July, 2025): This feature was available in early access and is currently being rolled out to customers in phases. Currently available for users in the the AU, CA, and SA DCs. It will be enabled for the remaining DCs in the next couple

• IMAP error message in Zoho mail

  I cannot send emails today. Everything fine for years until today. Get a message: "You are yet to enable IMAP for your account. Please contact your administrator". Does anyone know how to correct this?

• IMAP stopped working today

  Hello! I've been a paid customer for more than 10 years, IMAP was always working fine. But today this is the error I've got on my iPhone: I've tried toggling the IMAP for my account (Mail -> Settings -> Mail accounts) off and on again, but that did not

• Are custom portals accessible on the Zoho learn smartphone app?

  In other words, can users external to my organisation, once signed up, use the app in the same way as internal users? Thanks

• Zoho Books/Inventory - Update Marketplace Sales Order via API

  Hi everyone, Does anyone know if there is a way to update Sales Orders created from a marketplace intigration (Shopify in this case) via API? I'm trying to cover a scenario where an order is changed on the Shopify end and the changes must be reflected

• Conditional Layouts On Multi Select Field

  How we can use Conditional Layouts On Multi Select Field field? Please help.

• Multiple columns in a form

  I am evaluating Zoho Creator. However, I am seeing almost no layout control on a form.  Just a basic 1 or 2 column format that is then imposed on the entire form.  That's not going to work for many, many real world cases. We need multiple columns per line, and we need each line/section to occupy a single column or be able to span the columns.   Someone please tell me that I'm missing something and the capability is actually there.  

• Global search

  Hi! I think it would be great to have a global search that would give you results from all records of a database, no only for a single field of a single form as we have now. Thanks!

• Any insights about API/v2? Having problem for a while.

  I don't know why it is throwing a 404 error, my report name is correct. Has someone had this issue and how you fix it?

• Edit QR code with redirect to form

  Guten morgen, wir haben ein Formular Reklamation_erstellen. Dort soll ein QR Code erstellt werden, der im Lieferschein angezeigt wird. Beim Scannen auf dem soll das jeweilige Formular zum BEARBEITEN geöffnet werden. Leider bekomme ich es nur so hin, dass

• Getting all the ingredients together for baking an app

  Good day everyone. After reading a lot of the help docs and watching videos, I now started on my app. To prevent hours and hours wasted on going down the wrong track, I would like some clarification on the following. But first some background: I have

• Help Needed with Configuring ZC Microservice

  I'm attempting to create a simple microservice, but am running into problems with scope and auth. Using Custom API Builder, here's my setup: 1. Method: GET 2. Auth: OAuth2 3. User Scope: All users 4. Response: Standard 5. Function: A function that returns

• Creator Simplified #10: Predefine Form Field Values and Make Them Read-Only for Users

  Hey Creators, Ready for this week's tip in the Creator Simplified series? Today, we will explore how to have read only fields in a form. Use Case: Assume a scenario where the default value for a Department field needs to be English Literature, but you

• Zoho Mail : Email Outgoing Blocked

  I suddenly received the following message yesterday. I cannot send any mail. Please resolve as soon as possible, I cannot work without sending email. Dear User, We regret to inform you that your email outgoing has been blocked and you will not be able

• Creator and Tables

  Good day. I am trying to create my first application. I have imported my data into Tables and am creating my app in Creator. I do not see my tables and cannot see how to write forms data to a table. Even the Workflow just uses the form. In one of the

• customer Name and address details

  i created one application there is no customer details in that . how to add customer details and

• Recalculate every row in the subform

  Hello, Can anyone help me with a script, please? I have an issue. Sometimes it happens, that in a multi row subform one of the rows show an incorrect row total value. Not really understand how it can happen, if I have a 20 row subform, 19 rows show correct

• Creating Repeat Forms that remove redundancies

  I wanted to understand if you can make multi-layer forms that reduce the need for users to input information in again and again. We want a form that our suppliers fill out per ingredient they sell, and the end result should have the Ingredient (Section

• What is the difference between the free plan and the mail lite plan?

  What is the difference between the free plan and the mail lite plan? How many emails can I send per day?

• Unblock email

  Hi The outgoing mail from a client of me is blocked. I already made tickets and tickets are send to the EU desk but nobody is responding. The problem is already 4 days! There is absolutely no help from the support. I am really not satisfied at all! Can

• Domain verification failure

  Hello Zoho Support, I purchased my domain directly through Zoho Mail, but the domain verification keeps failing with the message “TXT verification failed.” I’ve already waited and retried several times, but it still won’t verify. Could you please manually

• Unable to send message;Reason:554 5.1.8 Email Outgoing Blocked.

  My email account is unable to send emails, and I urgently need to use it. How can I resolve this?If there is anything we have done wrong, please let us know in advance so we can actively cooperate to improve. User ID: 850482493

• URGENT: Email stopped workin - can't access admin panel

  For some reason email sending stopped working. When I try to send an email it fails with "Unable to send message;Reason:451 4.7.1 Temporary system error" I can receive email just fine I see in my notifications some errors about the MX records, however

• Can I associate an invoice to a Project after the fact?

  We have generated an invoice but would like to assoicate it to a Zoho Project after the fact.  Is there any way to accomplish that? Thanks, Scott

• Emails I send as a cc or bcc NEVER GO THROUGH TO THA RECEIVER !!

  every time i send a cc or bcc copy of an email to anyone when I’m using my zohomail.com email - no one ever gets the cc of bcc copy if the email: why???? And i triple check that the email addresses are correct; then i get back an email message (EVERYTIME)

• Cannot see correct DNS config for mail after moving domain to another provider

  I have moved my domain from one provider to another and after that zoho mail stopped working (expected). Problem is, zoho mail admin panel still shows (10 hours after move) that all records are correct while I haven't changed anything in my domain DNS

• Add Support for Authenticator App MFA in Zoho Desk Help Center

  Hello Zoho Desk Team, We hope you are doing well. We would like to request an enhancement related to security for the Zoho Desk Help Center (customer portal). Currently, the Help Center supports MFA for portal users via SAML, JWT, SMS authentication,

• Auto-fill Contacts in Zoho Mail not working for me

  We just switched to Zoho Mail for our company, and I am noticing that the "auto fill" feature when composing an email -- where the "to" field is autofilled (like in the attachment) from Contatcts works for everyone except me. Any way I might have made

• How to unlink a SAML user from the existing Zoho Desk user (domain change case)

  Hi everyone, I’m trying to understand how to handle a situation where a customer changes their company domain. In our setup, users authenticate via SAML, so when the domain changes, the SAML system treats them as a new user. However, in Zoho Desk, I’d

• Price Managment

  I have been in discussions with Zoho for some time and not getting what I need. Maybe someone can help explain the logic behind this for me as I fail to understand. When creating an item, you input a sales rate and purchase rate. These rates are just

• Next Page