Kaizen #60 - Get Records, Search Records, Query and Bulk Read APIs

Hi everyone.. Welcome back!

In this post, we will discuss when to use Get Records, Search Records, Query, and Bulk Read APIs to fetch records. Please note that the information in the article holds true for version 3 of Zoho CRM APIs.

Get Records API

The GET Records API allows you to fetch all the records from a module in your CRM account. 

When should you use GET Records API?

       Use this API to fetch a specific set of records whose IDs you already know, or to fetch all the records from a module without any filters, or using the pre-defined filters.

      For instance, when you want to render a mobile/web UI to show the list of records in a module or a specific custom view, you can make use of Get Records API.

Pagination

• You can retrieve up to 200 records using this API in a single call.
• To fetch more than 200 records, you must use pagination and make further API requests with the page parameter.
• For more than 2000 and up to a maximum of 100,000 records, use the page_token parameter in the request. The value for this parameter is available from the key "next_page_token" in the response of the first Get Records call. 
• You cannot use the page_token parameter with the page parameter.

Points to remember

• You should specify the field API names to fetch the records.
• You can fetch up to 50 fields using this API.
• You can sort the records by id, Created_Time and Modified_Time fields.
• Each Get Records API call consumes one API credit.

Examples

1. To fetch the records from 1801-2000 in the Leads module with the Last_Name and Email fields

[GET] "https://www.zohoapis.com/crm/v3/Leads?fields=Last_Name,Email&per_page=200&page=10"

The info JSON object in the response contains the next_page_token to retrieve the next set of records. 

2. To fetch after 2000 records

[GET] "https://www.zohoapis.com/crm/v3/Leads&fields=Last_Name,Email&per_page=200  &page_token="db8d4276axxxxxxx713748a4e""

Search Records API

Search Records API lets you search for records in a module based on a criteria that you define. You can search for records with a specific word in the text fields, or by email or phone fields across the specified module. You can also search for a variety of other fields like currency, Date, DateTime, picklists etc.

When should you use Search Records API?

      Use this API when you want to search for a specific text, phone or email in the records of a module, or when you want to do a module-level word search. Search API is the go-to API  when you know the details like email, phone or a specific text, but not the individual IDs of the records.

      For example, when you want to render a search box in your web/mobile UI, and do a module-level search for the word, use Search Records API. 

Pagination

• You can search for up to 200 records in one API request.
  
• To fetch more than 200 and up to 2000 records, use the page parameter.
  

Points to remember

• Your search criteria can have  equals, starts_with, in, equals, not_equal, greater_equal, greater_than, less_equal, less_than, starts_with, or between conditions.
• There will be a delay in accessing recently inserted or updated records using this API due to data indexing.
  
• Due to the indexing delay, it is advised not to use Search API to check for record duplication while creating a new record. 
• Each Search Records API call consumes one API credit. 
  

Examples

1. To search for all the Leads with the word Zoho in the record

[GET] curl "https://www.zohoapis.com/crm/v3/Leads/search?word=Zoho"

2. To fetch records from the Leads module whose Last_Name is 'Thomas' and First_Name starts with 'M'

[GET] curl "https://www.zohoapis.com/crm/v3/Leads/search?criteria=((Last_Name:equals:Thomas)and(First_Name:starts_with:M))"

Query 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.  This API allows you to search for a variety of fields like picklist, Date, DateTime, Lookup, Number, Currency, Boolean, or string fields, and sort the records on the basis of any field.

When should you use Query API?

      To query for a module's data and its lookup related data using various comparators, or when you want to query for records that fall into a custom view without actually creating one.

      For instance, when you want to filter all the products in a specific price range, with 4 stars and up rating, use Query API.

      You can also use Query API to query for records from cross module (linked via lookup field). Eg: Filtering deals based on the account's location and industry type. In this example, Deals is the primary module linked with Accounts module via the lookup field 'Accounts_Name'.

Pagination

• You can retrieve 200 records in one API call using this API.
  
• To fetch more than 200 records and upto 10000 records, use the OFFSET clause. 
  

Points to remember

• You can use DB comparators such as =, >, <, >=, <=, is null, is not null, between, in, not in, like, and not like in your search query.
  
• You can fetch a maximum of 10000 records using this API.
  
• You can use Query API to check for record duplication while creating a new record in your web/mobile UI apps.
  

• Each Query API call consumes one API credit.

Examples

1. Cross Module Filtering : To filter deals based on its corresponding account's location and industry type.

"select_query": "select Deal_Name, Stage, Probability, Type, Account_Name from Deals where ((Account_Name.Location = 'Texas') AND (Account_Name.Industry = 'Military'))"

2. Consider the following custom view.

You can fetch the records in the custom view using the following SELECT query, without actually creating the custom view.

{ "select_query": "select Last_Name, Owner.last_name from Leads where ((Industry  = 'ERP') and (Owner = '4876876000000327001')) OR (Rating =    'Acquired')" }

For more examples, refer to our Get Records through COQL page. 

TIP : If you want to fetch all the records in a module using COQL Query API, you can still use the COQL query to do it. For example, the below example will fetch all the records in the Leads module.

{  "select_query": "select Last_Name, Owner.last_name from Leads where ((Industry  = 'ERP') OR (Industry  != 'ERP'))"}

Bulk Read API

Bulk Read API lets you export data in bulk from a module. Using this API, you can export records based on a query, or export all the records in a module with or without filters. The main advantage of Bulk read API is in the huge number of records it can retrieve in one API call. While you can fetch 200 records per API call for GET Records API, Search Records API and Query API, you can export 200,000 records per API call using the Bulk read API. 

When should you use Bulk read API?

When you want to schedule a job to export huge volume of CRM data.

For instance, when you want to export the list of all the records from a  Zoho CRM  module to sync with your local ERP system's data store, use Bulk read API. 

Points to remember

• Bulk read is an asynchronous API.
  
• The result of the bulk read job will be available as a downloadable CSV/ICS file.
  
• Each Bulk read API call consumes 50 API credits.
  
• To export more than 200,000 records, use the page key in the request body. Setting page to '2' exports data starting from 200,001.
  

Sample Scenario

Let us now consider the case where you want to fetch (a)2000, (b)5000, (c)10000 and (d)15000 records from a module, and see which API is best-suited for each case.

Number of records	Get Records API	Search Records API	Query API	Bulk read API
2000	10 API calls 10 API credits Use pagination	10 API calls 10 API credits Use pagination	10 API calls 10 API credits Use OFFSET	1 API call 50 API credits
5000	25 API calls 25 API credits use pagination (up to 2000 records) & page_token (after 2000 records)	Not possible to fetch more than 2000 records	25 API calls 25 API credits Use OFFSET	1 API call 50 API credits
10000	50 API calls 50 API credits use pagination (up to 2000 records) & page_token (after 2000 records)	Not possible to fetch more than 2000 records	50 API calls 50 API credits Use OFFSET	1 API call 50 API credits
15000	75 API calls 75 API credits use pagination (up to 2000 records) & page_token (after 2000 records)	Not possible to fetch more than 2000 records	Not possible to fetch more than 10000 records	1 API call 50 API credits

To sum up, for up to 2000 records, the Get Records API, Search Records API, and Query API all use the same API credits. However, Query API has the edge over the other two because it provides you with greater flexibility to tweak your criteria, thanks to all the comparators and logical operations it supports.  If you intend to fetch 10,000 or more records asynchronously, the Bulk Read API is preferable in terms of API credits consumed. For synchronously fetching more than 10,000 records, use the Get Records API.

Feature	Get Records API	Search Records API	Query API	Bulk Read API
Maximum number of records per API call	200	200	200	200,000  For Events - 20,000
Maximum number of records that can be fetched	100,000	2000	10,000	100,000,000
Indexing Delay	No	Yes	No	NA
Pagination	Use page parameter to retrieve more than 200 records and page_token parameter for more than 200 records	Use page parameter to retrieve up to 2000 records	Use LIMIT and OFFSET to navigate and retrieve a maximum of up to 10,000 records	Use page key in the request body to fetch more than 200,000 records. Maximum possible value for page is 500
Sorting support	Limited (id, Created_Time and Modified_Time fields )	No	Yes	No
Credits per API call	1  3 - with CVID parameter	1	1	50

We hope you found this post useful. Let us know your thoughts in the comment section or reach out to us at support@zohocrm.com

Thank You!

Previous Kaizen Post : Creating alerts and custom messages using Client Script

Next Kaizen Post : Composite API

• Topic Participants

• Anu Abraham

  

• Abhishek - Zoho Partner

  

• Juan

• Ishwarya SG

  

• Rodger Brehaut

• 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

• Experience Zoho Show on Mac now!

  Work today isn’t tied to a single place, time, or routine. It happens in cafes between meetings, on flights, or late at night when ideas strike. And when ins, your tools need to be ready, wherever you are. That’s why we built the Zoho Show app for Mac.

• 【開催報告】東京 ユーザー交流会 Vol.4 | Zoho CRM 自動化のコツ ・Bookings のビジネス活用シーンとおすすめ機能を紹介

  ユーザーの皆さま、こんにちは。コミュニティチームの藤澤です。 11月28日(金)に新橋で「東京 ユーザー交流会 Vol.4」を開催しました。ご参加くださったユーザーの皆さま、ありがとうございました。ユーザー交流会の年内開催は、今回が最後でした。 この投稿では、当日のセッションの様子や使用した資料を紹介しています。残念ながら当日お越しいただけなかった方も、ぜひチェックしてみてください😊 ユーザー活用事例セッション：関数やクライアントスクリプトまで、CRMをもっと便利に Zoho CRM には、ワークフローやブループリントなど、さまざまな自動化に役立つ標準機能が備わっています。さらに、関数（Deluge）のようにスクリプトを記述して高度な自動化を実現することもできます。

• Kiosk Button Actions

  I need to add an action to a Kiosk Button to loop me back to start the kiosk again and I am not sure what that looks like (function, etc.).

• [Webinar] Automate generation of wills, trusts, POAs, and other estate planning documents with Zoho Writer

  Managing the lifecycle of the estate planning documents such as wills, trusts, and POAs, from client intake to final storage, can be complex and time-consuming. Join our live webinar to learn how Zoho Writer transforms this process by automating document

• Dependent drop-downs... how?

  Good day. I have 2 different situations where I need a dependent drop-down field. First is for a subform, where I want to show related fields for a specific customer on the main form. In my case it is a parent whose children make use of our school transport

• Client Portal ZOHO ONE

  Dear Zoho one is fantastic option for companies but it seems to me that it is still an aggregation of aps let me explain I have zoho books with client portal so client access their invoice then I have zoho project with client portal so they can access their project but not their invoice without another URL another LOGIN Are you planning in creating a beautiful UI portal for client so we can control access to client in one location to multiple aps at least unify project and invoice aps that would

• Reporting Limitation on Lead–Product Relation in Zoho CRM

  I noticed that Zoho CRM has a default Products related list under Leads. However, when I try to create a report for Lead–Product association, I’m facing some limitations. To fix this, I’m considering adding a multi-lookup field along with a custom related

• Series Label in the Legend

  My legend reads 'Series 1' and 'Series 2'. From everything I read online, Zoho is supposed to change the data names if it's formatted correctly. I have the proper labels on the top of the columns and the right range selected. I assume it's something in

• Dynamic Signature - Record owner

  Hi everyone, I’m using Zoho Writer merge templates from Zoho CRM and have two questions: Owner signature: How can I automatically insert the CRM record owner’s signature in the merged document? I’m not sure where this signature is stored or how to reference

• Set Warehouse based on Vendor

  Greetings. I would like to set automaticaly the Warehouse based on the Vendor. Context: I am working on an adaptation of a Purchase Order to be used as a Quotation. I have defined that when a user has to raise a quote the Vendor will be "PROCUREMENT" I would like to set the Warehouse to a predefined value when "PROCUREMENT" is set as Vendor. I have tried to do with the Automation feature using the Field Update option, but Warehouse does not is listed as a field. Can you help? Thanks in advance.

• search 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?

• Printing from Zoho Creator hosted on my own server to printers hosted on my clients local network

  Hello. Fairly new to Zoho Creator and looking for best options to be able to print from my application hosted on my own server to any printer hosted on my clients own local network. Any advice is welcome. Thank you.

• Add System Pre-Defined Lookup Field to Subform?

  Hi there! New to using Zoho, so this may already exist, but I'm having trouble figuring it out. Is there a way to get the system pre-defined Account Lookup field (in our case, renamed to Company Name), as the starting point for a subform? In our company,

• Numbered / bullet point List in Zho Cliq

  Hi, is there a way to format chat messages in Cliq like this Topic 1 Hey, I finished this project yesterday etc... Topic 2 I am still working on this etc...

• Cannot Access Subform Display Order in Deluge

  As highlighted in this community post, we still have to deal with the significant limitation of not being able to access the user-sorted order of subform rows through Deluge. This creates a major disconnect between the UI capabilities and backend automation,

• How many groups in Zoho Mail can I make?

  I'm currently on the free plan, which has a limit of 10 users. Does that limit includes groups too? If not, what is the limit for groups? Thanks!

• Feature Suggestion for Zoho Social: Auto-reply to Comments or Keywords

  Hi Zoho team, I'd like to suggest a very specific feature that would be extremely helpful for customer engagement: the ability to automatically send a reply to comments on posts — either all comments or those containing specific keywords. For example,

• My domain did not activate

  Hi, my domain (apsaindustrial.com.ar) did not activate, and the phone verification message never arrived. Please would you solve this problem? Thanks.

• Already have Zoho account. Not letting me log in

  I already have a Zoho account that is associated with my Google email and my phone number. Even though I'm already logged in to Zoho, when I click on the mail icon to access my email, it takes me to the pricing page. When I click on the free option, it

• ZOHO Mail App Not working

  There seems to be an issue with Zoho Mail App today. It is not connecting to server, internet is working fine, tried uninstalling app and reinstalling, loading circle keeps spinning round. Is there an update on the way?

• facing error 550 5.4.6 while sending emails

  Please help me fix this issue

• Allow Itemization for Recurring Expenses

  For whatever reason, one cannot itemize a Recurring Expense. This capability should be added. The use cases to support this are largely the same as what they were to allow for itemization in Expenses. Anything that would need to be itemized for a regular

• Zoho reply to not working. just reply to my self

  Hello. i using on my wordpress website a contact form from Wsform. i can set the reply to email there. normally it works. but since i am using your wordpress plugin zoho mail it doesn`t work. its not using the reply to (email from customer). I just can

• Painfully Slow Zoho mail

  Since yesterday Zoho Mail seems to have starting functioning very slowly and having a few bugs. It's slow to open mails, slow to send, slow to change between email accounts. Sometimes clicking on a particular folder (eg Sent folder) stops working and

• Can't receive any email from other platform

  Hello,everyone, i'm just join zoho and create two email accounts for my own business. I was using it to get a verified email from stripe, but can't receive it. and I use my private gmail account to send test email twice, first time show below reply, but

• Weekly Tips: Secure your attachment downloads with Zoho Mail

  Safety is one of our main concerns, whether it’s about device security or online protection. We use tools like fingerprint scanners, facial recognition, and two-factor authentication to keep our devices and email accounts secure. We use methods like OTP

• 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

• Zoho Creator integration with Sage 50

  Hi, Wondering if anyone has had any experience connecting Zoho to Sage 50 and could share any information on this matter. Thank you.

• Dropshipping Address - Does Not Show on Invoice Correctly

  When a dropshipping address is used for a customer, the correct ship-to address does not seem to show on the Invoice. It shows correctly on the Sales Order, Shipment Order, and Package, just not the Invoice. This is a problem, because the company being

• Conditional Email Forwarding

  How can I set conditional email forwarding of the users? For example: Mail should be forwarded to a address only if it comes from a particular sender. So, I want such email forwarding, which forwards mails based on particular conditions, like the incoming

• Incoming emails not appearing in Inbox

  Hello, I have an issue with incoming emails sent from my website (domain: h2ostop.si). Emails are visible in the Sent folder, which means they are successfully sent through Zoho SMTP, but they never appear in my Inbox. Nothing arrives in Inbox, Spam,

• Automatic Matching from Bank Statements / Feeds

  Is it possible to have transactions from a feed or bank statement automatically match when certain criteria are met? My use case, which is pretty broadly applicable, is e-commerce transactions for merchant services accounts (clearing accounts). In these

• Email Opt Out Question

  Has the problem where if a customer is emailed opt out prevents you sending standard emails? For me this feature is simply to stop any email marketing and should not block people from receiving emails via Zoho mobile, which makes no sense.

• Can No Longer Access Zoho Email Accounts from iPhone or iPad Apple Mail Apps ,.

  Keeps asking for password, Says ID or password incorrect. Tried creating a new app specific password. Same result. Is this possibly related to the server maintenance. Have verified all email settings, userid and password. This has worked for years until

• Latest update caused issue in using marathi typingzoho

  With latest update now marathi typing does Not work in zohonotebook. I preferred zoho over other because it was supporting marathi font without any distortion.. But after new update,keyborad simply does not work

• Login verification emails never received.

  I can't login to my account. You send a verification email, but it never arrives. This is a common problem, frequently caused by some relay point out there classifying the sender as a spammer. Is there anything I can do to bypass this? Maybe get a text

• Global lists for Multi select

  It would be great if I could select a global list to use for a multi select dropdown filed.

• Hotmail is blocking the zoho mail IP

  Greetings, Since last Tuesday (5 days ago today) I wrote to Zoho support and I still haven't received a single response (Ticket ID: 2056917). Is this how you treat people who pay for your email service? I am making this public so that those who want to

• Yahoo is rejecting e-mails sent from a Zoho server

  Diagnostic-Code: 4.7.0 [TSS04] Messages from 136.143.169.51 temporarily deferred due to unexpected volume or user complaints - 4.16.55.1; see https://postmaster.yahooinc.com/error-codes Remote-MTA: dns; mta5.am0.yahoodns.net

• Yahoo blocks e-mail sent from Zoho servers

  Getting this for a bunch of Yahoo addresses. Do you know if some of your servers got blacklisted? Diagnostic-Code: 4.7.0 [TSS04] Messages from 136.143.169.51 temporarily deferred due to unexpected volume or user complaints - 4.16.55.1; see https://postmaster.yahooinc.com/error-codes

• Next Page