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
Converting Sales Order to Invoice via API; Problem with decimal places tax
We are having problems converting a Sales Order to an Invoice via API Call. The cause of the issue is, that the Tax value in a Sales Order is sometimes calculated with up to 16 decimal places (e.g. 0.8730000000000001). The max decimal places allowed inEmpowered Custom Views: Cross-Module Criteria Now Supported in Zoho CRM
Hello everyone, We’re excited to introduce cross-module criteria support in custom views! Custom views provide personalized perspectives on your data and that you can save for future use. You can share these views with all users or specific individualsZoho Canvas - Custom templates for related lists
Hi, I see that the example pages load always one of our related lists in a custom template, but I dont know how to work with that: 1) How can i make my own custom templates for related lists? 2) Where and how can i check out existing custom templates?Kaizen #147 - Frequently Asked Questions on Zoho CRM Widgets
Heya! It's Kaizen time again, folks! This week, we aim to address common queries about Zoho CRM Widgets through frequently asked questions from our developer forum. Take a quick glance at these FAQs and learn from your peers' inquiries. 1. Where can Iopen word file in zoho writer desktop version
"How can I open a Microsoft Word (.doc or .docx) file in Zoho Writer if I only have the file saved on my computer and Zoho Writer doesn't appear as an option when I try 'Open with'? Is there a way to directly open the .doc file in Zoho Writer?"How to invite friends on other social media platforms to one of my group chats in arattai?
Hello, I have formed chat groups in arattai. I want to invite my friends on other social media platforms like WhatsApp/ FB to one of my groups. Different friends would be invited to different groups. How to share an invite link of one of my groups toZoho PDF editor has a lot of issues.
Zoho PDF editor needs a lot of work. It hangs and glitches a lot. Deletes annotations and clearings randomly.Writer sing up problom
Zoho writer sing up prolom faceEnable Password Import option in ulaa browser
Dear Ulaa Team, I noticed that the Ulaa Password Manager currently offers an option to export passwords, but not to import them. This limitation poses a challenge for users like me who have stored numerous credentials in browsers like Chrome. ManuallyZoho Sheet for Desktop
Does Zoho plans to develop a Desktop version of Sheet that installs on the computer like was done with Writer?Workdrive on Android - Gallery Photo Backups
Hello, Is there any way of backing up the photos on my android phone directly to a specific folder on Workdrive? Assuming i have the workdrive app installed on the phone in question. EmmaMarket cap
Market cap formula?? Kaise nikalestock
bom/bse : stock details or price =STOCK(C14;"price") not showing issue is #N/A! kindly resolve this problemZoho sheet desktop version
Hi Zoho team Where can I access desktop version of zoho sheets? It is important as web version is slow and requires one to be online all the time to do even basic work. If it is available, please guide me to the same.ZOHO SHEETS
Where can I access desktop version of zoho sheets? It is important to do basic work If it is available, please guide me to the sameOption to Empty Entire Mailbox or Folder in Zoho Mail
Hello Zoho Mail Team, How are you? We would like to request an enhancement to Zoho Mail that would allow administrators and users to quickly clear out entire folders or mailboxes, including shared mailboxes. Current Limitation: At present, Zoho Mail onlyZoho Books - France
L’équipe de Zoho France reçoit régulièrement des questions sur la conformité de ses applications de finances (Zoho Books/ Zoho Invoice) pour le marché français. Voici quelques points pour clarifier la question : Zoho Books est un logiciel de comptabilitéUsing Zoho Flow to create sales orders from won deal in Zoho CRM
Hi there, We are using Zoho Flow to create sales orders automatically when a deal is won in Zoho CRM. However, the sales order requires "Product Details" to be passed in "jsonobject", and is resulting in this error: Zoho CRM says "Invalid input for invalidIs Zoho Sheet available for Linux ?
Is Zoho Sheet available for Linux ?Bharat
ahow to disable staff selection Zoho Booking integrated to SalesIQ?
currently there is only one Consultant in my Zoho Bookings like this I integrate Zoho Bookings into Zoho SalesIQ to create a chatbot. Unfortunately, even though I only have one consultant for a consultation, the user have to pick the consultant. It willZoho Bookings No Sync with Outlook
Zoho Bookings appointments are showing on my Outlook Calendar but Outlook events are not showing on Zoho Bookings. How do I fix this?End Date in Zoho Bookings
When I give my appointments a 30 minutes time I would expect the software not to even show the End Time. But it actually makes the user pick an End Time. Did I just miss a setting?Custom confirmation message
How can I change the message that users see after they submit the booking form? I have to confirm some details before their appointment is officially "confirmed", so I want to change it where it doesn't say their appointment is "confirmed" but ratherIssue showing too many consultations in my workspace link.
Hi Team, I’ve set up two Workspaces to track meetings from different sources. So far, this has been working well, and the two Workspaces are differentiated without any issues. However, when I navigate to Consultations and share the link to my personalImproved RingCentral Integration
We’d like to request an enhancement to the current RingCentral integration with Zoho. RingCentral now automatically generates call transcripts and AI-based call summaries (AI Notes) for each call, which are extremely helpful for support and sales teams.Deluge sendmail in Zoho Desk schedule can't send email from a verified email address
I am trying to add a scheduled action with ZDesk using a Deluge function that sends a weekly email to specific ticket client contacts I've already verified the email address for use in ZDesk, but sendmail won't allow it in its "from:" clause. I've attachedZoho Learn & Zoho Connect
Hi, Is there a way to sync the knowledge base we have in Zoho Learn with the manuals section is Zoho Connect? Thanks,Addin Support in Zoho Sheet
Is there any addin support available in zoho sheet as like google marketplace to enhance productivity by connecting with other apps, providing AI data analysis, streamlining business processes, and more?Changing Corporate Structure - How Best to Adapt Current and Future Zoho Instances
My current company is Company A LLC with a dba ("doing business as" - essentially an alias) Product Name B. Basically, Company A is the legal entity and Product Name B is what customers see, but it's all one business right now. We currently have a Zohohow to add subform over sigma in the CRM
my new module don't have any subform available any way to add this from sigma or from the crmHow to Install Zoho Workdrive Desktop Sync for Ubuntu?
Hi. I am newbie to Linux / Ubuntu. I downloaded a tar.gz file from Workdrive for installing the Workdrive Desktop Sync tool. Can someone give me step by step guide on how to install this on Ubuntu? I am using Ubuntu 19.04. Regards SenthilHow to upload own video?
How can you upload your own video on your zoho website? I do not want to use another host, but i want to insert my own files. how can i do this?Support new line in CRM Multiline text field display in Zoho Deluge
Hi brainstrust, We have a Zoho CRM field which is a Muti Line (Small) field. It has data in it that has a carriage return after each line: When I pull that data in via Deluge, it displays as: I'm hoping a way I can change it from: Freehand : ENABLED ChenilleA couple of minor enhancements to Workflows
Last updated on September 17, 2024: These enhancements were initially available for early access, and we've now enabled them for all users. We are elated to announce a couple of enhancements to custom functions in our Workflows! Say hello to: "Source"Announcing new features in Trident for Windows (v.1.32.5.0)
Hello Community! Trident for Windows just got better! This update includes new features designed to improve and simplify email and calendar management—and it includes a feature you’ve been waiting for. Let’s dive into what’s new! Save emails in EML orHow to render either thumbnail_url or preview_url or preview_data_url
I get 401 Unauthorised when using these urls in the <img> tag src attribute. Guide me on how to use them!Zoho CRM Calendar | Custom Buttons
I'm working with my sales team to make our scheduling process easier for our team. We primary rely on Zoho CRM calendar to organize our events for our sales team. I was wondering if there is a way to add custom button in the Calendar view on events/meetingDefault Sorting on Related Lists
Is it possible to set the default sorting options on the related lists. For example on the Contact Details view I have related lists for activities, emails, products cases, notes etc... currently: Activities 'created date' newest first Emails - 'createdCreate Lead Button in Zoho CRM Dashboard
Right now to create Leads in the CRM our team is going into the Lead module, selecting the "Create Lead" button, then building out the lead. Is there anyway to add the "Create Lead" button or some sort of short cut to the Zoho CRM Dashboard to cut outNext Page