Kaizen #10 - Search Records API and Query API
Hello everyone!
Welcome back to this week's Kaizen post! In this post, we will discuss the Query API and the Search Records API, and when you should use them.
Query API
The Query API allows you to query the records using the CRM Object Query Language(COQL). COQL is based on the SQL syntax and uses the SELECT statement in the query to fetch records.
When should you use the Query API?
- When you want to use DB comparators such as =, >, <, >=, <=, is null, is not null, between, not in, like, and not like in your search query.
- When you want to search for records that fall into a custom view without actually creating one. Refer to the example below to know more.
- When you want to fetch data from other modules associated through lookup fields.
- When you want to search for fields of the data types Date, DateTime, Lookup, Number, Currency, and Boolean, in addition to string fields. Refer to Get Records through a COQL Query, for an example on each of these data types.
Here are a few examples.
1. Below is a custom view to fetch records from Leads, that belong to the Account Zylker and have the owner as shown in the image.
The equivalent select query for this custom view is
{ "select_query": "select Last_Name, Owner.last_name from Leads where (Account.Account_Name = 'Zylker' and (Owner = '3652397000001464001' or Owner = '3652397000000186017'))" } |
2. Another example is shown below to fetch data from other modules associated through lookup fields.
{ "select_query" : "select Last_Name, Account_Name.Parent_Account,Account_Name.Parent_Account.Account_Name from Contacts where Last_Name is not null and Account_Name.Parent_Account.Account_Name is not null" } |
In the Query API, you can establish a relation with the help of lookup fields that relate one module with the other. Note that you can only establish two relations.
In this query, two relations are established between the Accounts and Contacts modules. The records are fetched using the lookup field Account_Name in the Contacts module and another lookup field Parent_Account in the Accounts module.
Here, the relation Account_Name.Parent_Account returns the ID of the parent account of the account associated with the contact. The relation Account_Name.Parent_Account.Account_Name returns the name of the parent account of the account associated with the contact.
Here is the response to the above query.
{ "data": [ { "Account_Name.Parent_Account.Account_Name": "Zylker", "Last_Name": "Boyle", "Account_Name.Parent_Account": { "id": "554023000000238121" }, "id": "554023000000310003" }, { "Account_Name.Parent_Account.Account_Name": "Zylker", "Last_Name": "Patricia", "Account_Name.Parent_Account": { "id": "554023000000238121" }, "id": "554023000000310012" } ], "info": { "count": 2, "more_records": false } } |
Note
- COQL supports only SELECT query with the clauses WHERE, FROM, ORDER BY, LIMIT, and OFFSET.
- COQL keywords are not case-sensitive. SELECT is the same as select.
- By default, system sorts the records in ascending order based on the record ID, if you do not include order by in the query.
- The default value for LIMIT is 200 and OFFSET is 0.
- You can fetch a maximum of 200 records through a single query. To fetch the next set of records, specify the value of OFFSET as 200.
- You can establish a maximum of two relations.
Search Records API
The Search Records API allows you to run a search in a specific module, and takes a criteria, email address, phone number, or word as the parameter to narrow down the search.
When should you use this API?
- When you want to search for text in the fields of data type "string", "phone", or "Email".
- When you want to perform a module-level word search. For example, when your search term is "Zoho" in the Leads module, the search results include "all records" that contain the word "Zoho" in them in any field in the Leads module.
Handling parentheses and comma in the search string
When your search string includes parentheses or comma, you must escape them with a backslash(\).
Example: (Last_Name:starts_with:ABC\(inc\)), (Last_Name:starts_with:Patricia\,Boyle)
Note
If your search string has special characters apart from comma and backslash, you must encode them. Example: When you search by email, you must encode p.Boyle+z@abc.com to p.Boyle%2B@abc.com.
Here is an example Search Records API call.
curl "{{api-domain}}/crm/v2/Leads/search?criteria=((Last_Name:equals:Burns\,B)and(First_Name:starts_with:M))" -X GET -H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf" |
For more details and examples, refer to the Search Records API.
Note
- When you specify more than one parameter, only one of them would work at a time, and the order of preference is criteria, email, phone, or word.
- When you search for records that were modified recently, those records will not be available in response due to the delay in data indexing time. So, this API is best suited for searching texts in a faster way.
We hope you found this post useful. Let us know your thoughts in the comment section or reach us out at
support@zohocrm.com.
support@zohocrm.com.
We wish you all a Merry Christmas!
Cheers!
Access your files securely from anywhere
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
Shylaja S
Sticky Posts
Kaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provideClient Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! CommandsExtension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use APIKaizen #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 achievedExtension pointers for integrating Zoho CRM with Zoho products #8: Upload and manage Zoho Workdrive folders and files from within Zoho CRM
Keeping records on your customers and business prospects is essential for tracking data, conducting follow-ups, and running a business smoothly. When you use two separate applications, and store relevant data in each, checking and tracking data becomes
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho DataPrep Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho Campaigns 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セミナー