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 #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 #197: Frequently Asked Questions on GraphQL APIs
🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Kaizen #198: Using Client Script for Custom Validation in Blueprint
Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Celebrating 200 posts of Kaizen! Share your ideas for the milestone post
Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQsKaizen #193: Creating different fields in Zoho CRM through API
🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.
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
The sending IP (136.143.188.15) is listed on spamrl.com as a source of spam.
Hi, it just two day when i am using zoho mail for my business domain, today i was sending email and found that message "The sending IP (136.143.188.15) is listed on https://spamrl.com as a source of spam" I hope to know how this will affect the deliveryDelegates - Access to approved reports
We realized that delegates do not have access to reports after they are approved. Many users ask questions of their delegates about past expense reports and the delegates can't see this information. Please allow delegates see all expense report activity,Split functionality - Admins need ability to do this
Admins should be able to split an expense at any point of the process prior to approval. The split is very helpful for our account coding, but to have to go back to a user and ask them to split an invoice that they simply want paid is a bit of an inIs there a way to request a password?
We add customers info into the vaults and I wanted to see if we could do some sort of "file request" like how dropbox offers with files. It would be awesome if a customer could go to a link and input a "title, username, password, url" all securely and it then shows up in our team vault or something. Not sure if that is safe, but it's the best I can think of to be semi scalable and obviously better than sending emails. I am open to another idea, just thought this would be a great feature. Thanks,Single Task Report
I'd like a report or a way to print to PDF the task detail page. I'd like at least the Task Information section but I'd also like to see the Activity Stream, Status Timeline and Comments. I'd like to export the record and save it as a PDF. I'd like theAuto-response for closed tickets
Hi, We sometimes have users that (presumably) search their email inbox for the last correspondence with us and just hit reply - even if it's a 6 month old ticket... - this then re-opens the 6 month old ticket because of the ticket number in the email's subject. Yes, it's easy to 'Split as new Ticket', but I'd like something automated to respond to the user saying "this ticket has already been resolved and closed, please submit a new ticket". What's the best way to achieve this? Thanks, EdHow to Push Zoho Desk time logged to Zoho Projects?
I am on the last leg of my journey of finally automating time tracking, payments, and invoicing for my minutes based contact center company - I just have one final step to solve - I need time logged in zoho desk to add time a project which is associatedCannot access KB within Help Center
Im working with my boss to customize our knowledge base, but for some reason I can see the KB tab, and see the KB categories, but I cannot access the articles within the KB. We have been troubleshooting for weeks, and we have all permissions set up, customersExport to excel stored amounts as text instead of numbers or accounting
Good Afternoon, We have a quarterly billing report that we generate from our Requests. It exports to excel. However if we need to add a formula (something as simple as a sum of the column), it doesn't read the dollar amounts because the export storeswhy my account is private?
when i post on zohodesk see only agent onlyGetting ZOHO Invoice certified in Portugal?
Hello, We are ZOHO partners in Portugal and here, all the invoice software has to be certified by the government and ZOHO Invoice still isn´t certified. Any plans? Btw, we can help on this process, since we have a client that knows how to get the software certified. Thank you.500 Internal Server Error
I have been trying to create my first app in Creator, but have been getting the 500: Internal Server Error. When I used the Create New Application link, it gave me the error after naming the application. After logging out, and back in, the application that I created was in the list, but when I try to open it to start creating my app, it gives me the 500: Internal Server Error. Please help! Also, I tried making my named app public, but I even get the error when trying to do that.Client Script | Update - Client Script Support For Portals
Dear All! We are excited to announce the highly anticipated feature: Client Script support for Portals. We understand that many of you have been eagerly awaiting this enhancement, and we are pleased to inform you that this support is now live for allProfessional Plan not activated after payment
I purchased the Professional Plan for 11 users (Subscription ID: RPEU2000980748325) on 12 September 2025, and the payment has been successfully processed. However, even after more than 24 hours, my CRM account still shows “Upgrade” and behaves like ahow to edit the converted lead records?
so I can fetch the converted leads records using API (COQL), using this endpoint https://www.zohoapis.com/crm/v5/coql and using COQL filter Converted__s=true for some reasons I need to change the value from a field in a converted lead record. When I tryAuto Update Event Field Value on Create/Edit
Hi there, I know this question has been posted multiple times and I've been trying many of the proposed similar scripts for a while now but nothing seems to work... what might I do wrong? The error I receive is this: Value given for the variable 'meetingId'Pre-orders at Zoho Commerce
We plan to have regular producs that are avaliable for purchase now and we plan to have products that will be avaliable in 2-4 weeks. How we can take the pre-orders for these products? We need to take the money for the product now, but the delivery willConstant color of a legend value
It would be nice if we can set a constant color/pattern to a value when creating a chart. We would often use the same value in different graph options and I always have to copy the color that we've set to a certain value from a previous graph to makeZoho Pagesense really this slow??? 5s delay...
I put the pagesense on my website (hosted by webflow and fast) and it caused a 5s delay to load. do other people face similar delays?Payroll and BAS ( Australian tax report format )
Hello , I am evaluating Zoho Books and I find the interface very intuitive and straight forward. My company is currently using Quickbooks Premier the Australian version. Before we can consider moving the service we would need to have the following addressed : 1.Payroll 2.BAS ( business activity statement ) for tax purposes 3.Some form of local backup and possible export of data to a widely accepted format. Regards Codrin MitinProblem with Email an invoice with multiple attachments using API
I have an invoice with 3 attachments. When I send an email manually using the UI, everything works correctly. I receive an email with three attachments. The problem occurs when I try to initiate sending an email using the API. The email comes with onlyPage Layouts for Standard Modules like CRM
For standard modules like quotes, invoices, purchase orders, etc, it would be a great feature to be able to create custom page layouts with custom fields in Zoho Books similar to how you can in Zoho CRM. For example, and my current use case, I have aNon-depreciating fixed asset
Hi! There are non-depreciable fixed assets (e.g. land). It would be very useful to be able to create a new type of fixed asset (within the fixed assets module) with a ‘No depreciation’ depreciation method. There is always the option of recording landFixed asset management
I want to know if there is any individual module for fixed assets managementOne time sale item in billing automatically detects as service
if i have some items which i don't want to add in my "item" list because its sold only for one time. but when i type item name in invoice, it (system) automatically takes it as a service and despite of HSN , it shows SAC code to be entered. if its selectable i.e. either item or service , it would be very helpful and a must have feature.Project template after project creation
How can I apply a project template AFTER the project has been created?convert the project to templet
i have some deployment ME product for different customer , i need to create a fixed template for use it rather then keeping creating this template every timeSeriously - Create multiple contacts for leads, (With Company as lead) Zoho CRM
In Zoho CRM, considering a comapny as a lead, you need us to allow addition of more than one contact. Currently the Lead Section is missing "Add contact" feature which is available in "Accounts". When you know that a particular lead can have multipleRelated Module in Sharing Rules
Zoho CRM team recently added the feature to filter records by Related Records It will be really beneficial if we can have this feature for Sharing Rules as wellAssignment Thresholds Resetting After Lead Conversion
Hello everyone, We're facing an issue with Zoho CRM's lead assignment thresholds that makes them unsuitable for our workflow. I'm hoping to find a potential workaround or solution from the community. Here’s our current process: A new lead is created automaticallyZoho CRM Analytics - Allow To Reorder Dashboards
I would like to suggest that you add the ability to reorder dashboards in the Analytics Module. I can see that this has been requested some time ago, the latest 9 years ago. I am not sure if this is a big or small endeavor, but such a small fix can goTerritory view for custom modules?
I have recently activated territories however I can't seem to find how to use territories for custom modules? These modules have territories: Contacts / Accounts / Opportunities These modules don't have territories: Buildings (custom module) andZoho Books - How to Invoke a Custom Function in Schedulers
We have multiple schedulers that send emails to customers in batches. Currently, we are maintaining the same code across several schedulers. Is it possible to use a custom function inside a scheduler script? If yes, how can we invoke the custom functionApproval Process Comments
Is it possible to view the comments entered during the approval or rejection of a record in the approval process? If not, is there a way to require a field to be completed upon approval or rejection?Login for test case
Had a few questions regarding authentication test cases and couldn't find an answer in the the docs. 1. If an app like Zoho Creator requires authentication before providing access, do I need to create a login function and add it to each test case? 2.Zoho / Outlook Calendar sync
The current Marketplace -> Microsoft -> Meetings integration needs 2 changes. 1. The current language for the Two-Way sync option should be changed. It currently states, "Sync both your Zoho CRM Calendar and Office 365 Calendar meetings with each other."Customer members area
Does FSM support a customer members area? If not what do you propose we use if we want the data used in FSM for customers to give them an area / login to see past orders, create new orders and general announcements.Zoho Books-Accounting on the Go Series!
Dear users, Continuing in the spirit of our 'Function Fridays' series, where we've been sharing custom function scripts to automate your back office operations, we're thrilled to introduce our latest initiative – the 'Zoho Books-Accounting on the Go Series'.Desktop app doesn't support notecards created on Android
Hi, Does anybody have same problem? Some of last notecards created on Android app (v. 6.6) doesn't show in desktop app (v. 3.5.5). I see these note cards but whith they appear with exclamation mark in yellow triangle (see screenshot) and when I try toNotes created in mobile can no longer be accessed in desktop
Working with a 2013 Mac running OS 10.14.6; Desktop Notebook version 4.5.3. Using Motorola Moto G Power 5G - 2024; Android app version 6.7 I have been using Notebook for some years. Starting several weeks ago, the notes newly created ion the phone canNext Page