Kaizen #178 - Filters & Criteria in Zoho CRM APIs
Hey everyone, and welcome back to another week of Kaizen!
Ever felt overwhelmed by the sheer volume of data in your Zoho CRM? Sifting through countless records to find exactly what you need, or to operate on specific records that meet a certain criteria, can indeed be a real time-sink. Fortunately, Zoho CRM provides powerful filtering capabilities through its APIs to streamline this process.
What is criteria or filter?
In Zoho CRM APIs, criteria refer to the conditions applied to filter records when making API requests. These conditions can be simple (single condition) or complex (multiple conditions) and are specified using various comparators.
Depending on the API type and request method, the filter can be provided either:
- As a query parameter (filters) – Used in GET requests.
- As an input key in the request body (criteria)– Used in POST and PUT requests
Where is "filters" used in Zoho CRM APIs?
The filters parameter is supported across multiple Zoho CRM API endpoints, including but not limited to:
- Get user groups API - GET /settings/user_groups
- List of Available APIs - GET /__apis
- Delete Recycle Bin Records API - DELETE /settings/recycle_bin?filters={filter_value}
Where is "criteria" used in Zoho CRM APIs?
The criteria key is supported across multiple Zoho CRM API endpoints, including but not limited to:
- Bulk Read API - POST /read
- Export Audit Log API - POST /settings/audit_log_export
- Record Locking Configuration API - POST /settings/record_locking_configurations?module={module_API_name}
The filters parameter and criteria key are supported across multiple Zoho CRM API endpoints. Refer to our API help documentation for individual APIs to check if these options are available. Check the Parameters section for filters and the Input JSON section for criteria
in the API's help documentation.
in the API's help documentation.
Constructing a criteria or a filter
Zoho CRM APIs use JSON-based criteria/filters expressions, which consist of:
- Field API Name – The field to filter (e.g., Email, Created_Time, Status).
- Comparator – The operator defining how the field should be compared (equals, greater_than, etc.).
- Value – The specific value to compare against.
Single Condition
A single condition is structured as follows:
{
"field": {
"api_name": "Post_Number"
},
"comparator": "greater_than",
"value": 1
}
Here,
- field specifies the API name of the field to be filtered.
- comparator indicates the type of comparison to be made (e.g., greater_than).
- value is the value against which the field is compared.
Multiple Conditions
When multiple conditions are required, they can be grouped using the logical operators "and" or "or". Here’s the syntax of how to structure multiple conditions:
{
"group_operator": "or",
"group": [
{
"field": {
"api_name": "Post_Number"
},
"comparator": "greater_than",
"value": 1
},
{
"field": {
"api_name": "Pre_Number"
},
"comparator": "greater_than",
"value": 1
}
]
}
Here,
- group_operator can be "and" or "or". It defines how the conditions within the group array are evaluated. "and" means all conditions must be true, while "or" means at least one condition must be true.
- group
contains an array of condition objects, each with its own field, comparator, and value.
Following is an example for a criteria with more than two conditions:
{
"criterion": {
"group_operator": "and",
"group": [
{
"field": {
"api_name": "Post_Number"
},
"comparator": "greater_than",
"value": 1
},
{
"group_operator": "or",
"group": [
{
"field": {
"api_name": "Pre_Number"
},
"comparator": "greater_than",
"value": 1
},
{
"field": {
"api_name": "Status"
},
"comparator": "equals",
"value": "Active"
}
]
}
]
}
}
Supported Comparators for Different Field Types
The available comparators depend on the field type. The following table outlines the supported comparators for different field types:
Field Type | Supported Comparators | Example |
text/ textarea | equal, not_equal, contains, not_contains , starts_with, ends_with | { "comparator": "equal", "field": { "api_name": "text" }, "value": "zoho" } |
email | equal, not_equal, contains, not_contains, starts_with, ends_with | { "comparator": "contains", "field": { "api_name": "Email" }, "value": "patricia" } |
phone | equal, not_equal, contains, not_contains, starts_with, ends_with | { "comparator": "equal", "field": { "api_name": "Phone" }, "value": "9999999999" } |
website | equal, not_equal, contains, not_contains, starts_with, ends_with | { "comparator": "contains", "field": { "api_name": "website" }, "value": "zoho" } |
picklist | equal, not_equal, contains, not_contains, starts_with, ends_with | { "comparator": "equal", "field": { "api_name": "picklist" }, "value": [ "Cold Call", "Call" ] } |
multiselectpicklist | equal, not_equal, contains, not_contains, starts_with, ends_with | { "comparator": "equal", "field": { "api_name": "Multi_Select_Picklist" }, "value": [ "Cold Call", "Call" ] } |
date | equal, not_equal, less_than, greater_than, between, not_between, less_equal, greater_equal | Example 1: { "comparator": "less_than", "field": { "api_name": "date" }, "value": "01-01-2025" } Example 2: { "comparator": "between", "field": { "api_name": "date" }, "value": [ "01-01-2025", "02-01-2025", } |
datetime | equal, not_equal, less_than, greater_than, between, not_between, less_equal, greater_equal | { "comparator": "equal", "field": { "api_name": "date" }, "value": "2025-01-01T12:12:06+05:30" } |
autonumber | equal, not_equal, contains, not_contains, starts_with, ends_with | { "comparator": "starts_with", "field": { "api_name": "Auto_Number" }, "value": "A01" } |
integer | equal, not_equal, less_than, less_equal, greater_than, greater_equal, between, not_between | { "comparator": "equal", "field": { "api_name": "integer" }, "value": 4 } |
currency | equal, not_equal, contains, not_contains, starts_with, ends_with | { "comparator": "equal", "field": { "api_name": "Currency" }, "value": "INR" } |
double | equal, not_equal, less_than, less_equal, greater_than, greater_equal, between, not_between | { "comparator": "equal", "field": { "api_name": "Double" }, "value": "123" } |
Boolean | equal | { "comparator": "equal", "field": { "api_name": "Boolean" }, "value": true } |
big int | equal, not_equal, less_than, less_equal, greater_than, greater_equal, between, not_between | { "comparator": "equal", "field": { "api_name": "id" }, "value": "1234800023843923" } |
lookup | equal, not_equal, less_than, less_equal, greater_than, greater_equal, between, not_between | { "comparator": "equal", "field": { "api_name": "Lookup.name" }, "value": "Name1" } |
ownerlookup/userlookup | in, not_in | { "comparator": "equal", "field": { "api_name": "Modified_By", "id": "400029000000000479" }, "value": [ { "id": "400029000003984001", "name": "User1" }, { "id": 400029000003984002, "name": "User2" } ] } |
formula | Comparator will depend on the return type | - |
Note:
- Use quotes for strings and picklists; do not use quotes for numbers and boolean values.
- While Zoho CRM’s filtering capabilities are extensive, certain field types — including subforms, multi-select lookup fields, multi-user lookup fields, and multi-module lookup fields — are not supported in filters and criteria. The above table lists all the supported field types.
Filtering in COQL Queries
COQL (CRM Object Query Language) provides a structured way to retrieve records from Zoho CRM using SQL-like queries. Unlike the standard API filters discussed above, COQL uses the WHERE clause to define conditions.
Here is a sample COQL query:
{
"select_query": "SELECT Full_Name, Email FROM Leads WHERE Lead_Status = 'Qualified'"
}
Here, Lead_Status = 'Qualified' acts as the filtering criteria.
{
"select_query": "SELECT Full_Name, Email FROM Leads WHERE (Lead_Status = 'Qualified' AND City = 'New York') OR (Industry = 'Software')"
}
The AND and OR operators allow for multiple conditions in the WHERE clause. We have covered COQL API, and all the supported field types and operators in detail in our Kaizen posts. Kindly refer to them for more details.
Criteria in Search API
In Search API, filtering records is done using the criteria (string) input key in the request body. Unlike filters in GET requests or criteria in other APIs, criteria here is a text-based filter expression that follows a specific syntax.
(({api_name}:{operator}:{value})and/or({api_name}:{operator}:{value}))
- You can combine up to 10 conditions using and or or.
- Only the equals operator is supported for encrypted fields.
- When using "equals" in Search API, it behaves like "contains", meaning it fetches records that include the specified value, not just exact matches.
- If you use parentheses (), commas, or backslashes \ in values, you must escape them properly and encode the value before making the request.
Field Type | Supported Operators |
Date, DateTime | equals, not_equal, greater_equal, greater_than, less_equal, less_than, between, in |
Integer, Currency, Decimal | equals, not_equal, greater_equal, greater_than, less_equal, less_than, between, in |
Boolean | equals, not_equal |
textarea | equals, not_equal, starts_with |
Lookup (user/owner) | equals, not_equal, in |
Picklist, Autonumber | equals, not_equal, in |
Text, Email, Phone, Website | equals, not_equal, starts_with, in |
multiselectpicklist | equals, not_equal, in, starts_with. |
bigint | equals, not_equal, greater_than, greater_equal, less_than, less_equal, between, in |
percent | equals, not_equal, greater_than, greater_equal, less_than, less_equal, between, in |
formula | The supported operators of the formula datatype will depend on the return type of the formula |
Have questions or use cases to share? Feel free to share them in the comments below or reach out to our support team directly at support@zohocrm.com.
Thank you for joining us this week. Stay tuned for more insights in our upcoming Kaizen posts! Happy Coding!!
- More enhancements in the COQL API are now live in Zoho CRM API Version 7. Check out the V7 Changelog for detailed information on these updates. ✨
- OAuth Scopes page for Zoho CRM APIs. ✨
Previous Kaizen: Kaizen #177: Duplicate Check Preferences API vs. Upsert API | Kaizen Directory
Access your files securely from anywhere
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Anu Abraham
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 areKaizen #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 achievedKaizen #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
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
Exciting Updates to the Kiosk Studio Feature in Zoho CRM!
Hello Everyone, We are here again with a series of new enhancements to Kiosk Studio, designed to elevate your experience and bring even greater efficiency to your business processes. These updates build upon our ongoing commitment to making Kiosk a powerfulsearch and Smart Bar both missing in Mail
One of the users on my account does not have the search bar at the top right or the Smart Bar at the bottom left of the desktop Mail app. Any ideas how to get those back?"Wrong password or login" Problem to configure Zoho on MAIL App on my Macbook
Hi, I'm having problems to configure my e-mail on my MAIL App(Macbook pro). My e-mail is hari@trespontoum.net Actually was working perfectly, and still working on my Iphone. My MAIL App prompt me that my login or password is wrong. I tried to change 3Remote Control Functionality During Screen Sharing in Zoho Cliq
Hello Zoho Cliq Team, We would like to request the addition of remote control functionality during screen sharing sessions in Zoho Cliq. Currently, while screen sharing in Cliq is very useful, it lacks the ability for another participant to take controlLooking for best practices to import data from SAP Business One (on-prem) into Zoho Analytics via Zoho DataPrep / Databridge — daily automated schedule
Hi all, I’m using SAP Business One on-prem (SQL Server / or HANA — depending on DB backend) as our ERP. I want to build a pipeline that, every morning at 9:00 AM IST: pulls transactional data (invoices, customers, products, stock, etc.) from SAP B1, loadsLet us add Lookup fields in the Blueprint Transitions
We are unable to add Lookup Fields in the blueprint transitions in Zoho Desk, we wanted to make it a requirement for our workflow but since it's not available in the transition we cannot. The lookup field exists in the Layout: But it cannot be added/selectedZoho Projects API Scope for Issue Attachments
I try to download issue attachments via the API, unfortunately I always get the following error code when trying to download the file from the supplied URL: {"ERROR_MESSAGE":"INVALID_OAUTHSCOPE","ERROR_CODE":401} indicating an auth scope error. I've triedHow to fetch custom fields for time entries in Zoho Project API v3
In the previous Zoho Projects REST API, we were able to retrieve custom field details for time entries, including picklist options, using the endpoint: GET /restapi/portal/[PORTAL_ID]/timesheetcustomfields In the new Zoho Projects API v3, we tried usingZoho Survey Enhancements
We love Survey. We use it a ton. It needs some enhancements. Maybe some of these are already on the roadmap? API - this is crucial. We have some complex surveys that take place and need to update records, trigger other functions/automations, etc. I wouldImages Don't Display on Blog
Hi, I've just posted a new blog entry, but regardless of format (png or jpeg) Images that display in Preview mode do not display on any browser in the published post. I've not done anything different with this post than others regarding images, please advice. Thanks! Edit: I've discovered that moving the image files from a my sub directory folder "Pics for Blog" to the top level of the "Files" folder on my site allows the images to display live. This, even though my other blog posts are correctlyCreating multiple CRM leads from a Zoho Forms subform
Hi all, We have a heavily used intake form that is used for new leads as a part of our intake. There is a subform that allows the lead to add additional team members, their titles and other basic info. That form submission creates a new Lead and the subformCheckbox Field Mapping Zoho Forms to Zoho Sign
I have an application that will be filled out via Forms that I am mapping into a PDF Filler on Zoho Sign. I need to have a series of checkboxes mapped to the corresponding fields in Sign and I only see single checkboxes available via the mapping, thoughMCP > Creator connection failing with Claude
I'm trying to get claude to access any of my Zoho Creator apps and it keeps failing. I have enabled all tools for creator and ensured in claude settings that everything is authorised. Here is what claude says : Unfortunately, the error messages I'm receivingBooks P&L by Customer
Lately, we have found that the Customer field filter for the Profit & Loss report in Zoho Books is no longer available. We have several projects with the same customer and look at the P&Ls by project AND by Customer (overall). Can you please add back in this field selection alongside the Project field to the P&L report filter? Thanks! -GinaSent mail sort by date disappeared
Hello, We used to be able to sort the emails by date in the sent folder, but this feature has recently disappeared. Can we bring it back?I cannot check out to Zoho People.
When I tried to check out today, there's prompt that inhibits me to check out: To add entry in Attendance, log time for any of your jobsPricing Strategies: #2 Plan your Service Offerings using Plans
Meet Harvey & Mia, hailing from the same Tech school, carrying the dream of setting up their own IT maintenance firm in their location. They drew up a clear business plan and put their business in motion on New Year's Eve. They had great reception rightOpen a record to edit based on another form being edited
Hi all, I am trying to edit a record based on another record being edited. It works out like this: When I create a Monthly_Update and then submit I open the Monthly_Levels form and pass the ID from the Monthly_Update to a field called mu. I want it toProblem with signature on zoho survey
Hello, I'm trying to export individual responses with signatures on zoho survey. But the signatures on some of my surveys are not exported as the original image, but as a generic image, same for all (screen joins). Is there a solution to have the signaturesChange in Zoho CRM API?
Hello, I am using the Zoho API trough the PHP SDK v2.1 Since few days, I noticed that I have to change the way I pass the data to the API when I create, update, or upsert a record. Dates Before I was passing a PHP date object to "$record->addKeyValue(...)",MTA - BAD IP reputation by outlook/hotmail
Messages to Microsoft email servers are bouncing back due to poor reputation. Message: 4.7.650 The mail server [136.143.188.206] has been temporarily rate limited due to IP reputation. For e-mail delivery information see https://postmaster.live.com (S775)QuickBooks Extension for Zoho CRM - Advanced Features -2025
Hello Everyone, We’re happy to announce the latest version of our QuickBooks Extension for Zoho CRM, now officially live on the Zoho Marketplace! This release introduces one-click data sync, a user-friendly UI, enhanced performance, and a powerful setChanging Department often causes the Firefox tab to freeze
Title, it doesn't seem to happen with neither Opera nor Chrome. And even in Firefox, sometimes it just lets me change the department I'm in no problem, even to All Departments which is probably the most, like, resource heavy? But most of the time, theNeed to integrate Zoho Mail Mobile app with Zoho Meeting Mobile App for Android and Apple
Hello Zoho Team, Please bring integration of Zoho Mail Mobile app with Zoho Meeting for Android and Apple Thanks¡Muchas gracias por participar a los Meetups de Usuarios de Zoho! Y Novedades del ecosistema Zoho
¡Hola Comunidad de Zoho en Español! 👋 Después de un breve lapso de tiempo, volvemos con una nueva edición de nuestro Community Digest, donde te contamos las novedades de los productos de Zoho en los últimos meses. Estas mejoras se centran en nuestrosAnyway to move mail from one account to another yet?
Hello, Is there any way to move email from one mailbox account to another mailbox account in zoho yet? Thanks, Ryan.Using a CRM Client Script Button to create a Books Invoice
Hello, I need help handling error messages returned to my client script from a function. The scenario I have setup a client script button which is available from each Deal. This CS executes a crm function, which in turn creates an invoice based on theBuilding Toppings #2 - Learn how to use Bigin's Developer Console to build toppings
Hey Biginners, In our last post, we discussed what toppings are, why they're essential to extending Bigin's capabilities, and how the Bigin Developer Center serves as the starting point for building them. As a cloud platform, the Developer Center empowersProposal for Creating a Unique "Address" Entity in Zoho FSM
The "Address" entity is one of the most critical components for a service-oriented company. While homeowners may change and servicing companies may vary, the address itself remains constant. This constancy is essential for subsequent services, as it providesLinks are incorrect when sent out
I'm adding in hyperlinks into my eDM. When I send a test email, it's all correct. However, when I send out the eDM, all the hyperlinks jump up one space so none of the links are opening to the correct page. Why is this happening and how can I fix it?Tip of the week #16 - Search and filter threads based on criteria
Zoho TeamInbox lets you search and filter threads with any information that you have about the thread. You just have to input the criteria and Zoho TeamInbox will list all the threads that match the condition. Firstly, there is a global search you canIntroducing recipient authentication via Stripe Identity in Zoho Sign
Hi everyone! It's important to authenticate your recipient's identity before they access and sign important documents to ensure the highest level of compliance. Zoho Sign already helps businesses do this with various authentication methods: SMS OTP EmailIntroducing Multi-Asset Support in Work Orders, Estimates, and Service Appointments
We’re excited to announce a highly requested enhancement in Zoho FSM — you can now associate multiple assets with Work Orders, Estimates, and Service Appointments. This update brings more clarity, flexibility, and control to your field service operations,CRM: hosting a single html file in Zoho and displaying it as a widget
I have seen that CRM offers the option of uploading a web project to Zoho itself and displaying it as a widget in CRM. The instructions then talk about setting a development environment with Node and developing an application to upload to Zoho. But IKeep Converted Leads
How do I keep the converted leads in the Leads Module after conversion (converting it to account, contact, deal). I want to add it in a converted stage in the leads module in order to get a report or dashboard and see all converted leads from my pipCustomizing Global Search Settings for All Users
Hi Our team use the brilliant global search functionality within CRM many many times daily. But, we struggle with the out-of-the box columns that CRM gives you. We are always telling users to customize this look to more suit our business, to show theIntroducing Formula Fields for performing dynamic calculations
Greetings, With the Formula Field, you can generate numerical calculations using provided functions and available fields, enabling you to derive dynamic data. You can utilize mathematical formulas to populate results based on the provided inputs. ThisFrom Zoho CRM to Paper : Design & Print Data Directly using Canvas Print View
Hello Everyone, We are excited to announce a new addition to your Canvas in Zoho CRM - Print View. Canvas print view helps you transform your custom CRM layouts into print-ready documents, so you can bring your digital data to the physical world withTip of the Week #77– Stay informed of the activities happening in your organization
Whenever a message is handled in Zoho TeamInbox, every action is recorded in the Activity Log. This ensures you always know what’s happening across your teams and inboxes. To access it, simply click the Audits icon on the left pane’s top bar after loggingZoho Logs - Not seeing logs since 30 Nov
Hi, we have a few functions running, I am testing some new ones and noticed that although I can see executions, I cannot see any logs, even when the first line on the functions is a log. I reviewed some existing functions, one of which is invoked on aNext Page