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 #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.

• Kaizen #226: Using ZRC in Client Script

  Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In this

• Kaizen #222 - Client Script Support for Notes Related List

  Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore how

• 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

• Recent Topics

• API keys not showing in ZeptoMail dashboard

  Hi there, I'm hoping someone can provide some assistance as support isn't replying. I am trying to configure my transactional emails, but the dashboard doesn't show any of my API details - the `div` is there but it's emtpy. Every time I click "Generate

• Is there a way to show contact emails in the Account?

  I know I can see the emails I have sent and received on a Contact detail view, but I want to be able to see all the emails that have been sent and received between all an Accounts Contacts on the Account Detail view. That way when I see the Account detail

• Does Zoho Learn integrate with Zoho Connect,People,Workdrive,Project,Desk?

  Can we propose Zoho LEarn as a centralised Knowledge Portal tool that can get synched with the other Zoho products and serve as a central Knowledge repository?

• Reading from and writing to Zoho Projects Custom Module with Deluge

  Does anyone know if there is a way to read from and write to the Custom Modules that Zoho now supports. I would love to be able to loop through a set of data and create the entities I need to for this new custom module I'm looking to put together.

• How Does Knowledge Base Search and Article Recommendation Work?

  Hello, I would like to understand how the Knowledge Base search engine works. Specifically, does it search based on: The article title only? The full article content? Both, the article and the content? Keywords? Tags? Also, how does the system determine

• Importing into Multiselect Picklist

  Hi, We just completed a trade show and one of the bits of information we collect is tool style. The application supplied by the show set this up as individual questions. For example, if the customer used Thick Turret and Trumpf style but not Thin Turret,

• Zoho Books/Inventory - Restrict Items With Pricebook

  Hi Zoho Team, I'm trying to address as use case where a client needs to restrict which products certain customers can purchase. I have been able to find a way to do this based on the current Zoho Books or Zoho Inventory configuation. My feature request

• Best Way to Integrate Zoho Campaigns with Amazon SES Without Third-Party Tools

  I am looking for the most seamless and efficient method to integrate Zoho Campaigns with Amazon SES. My goal is to avoid using any third-party automation tools like Zapier, Make, or Pabbly, and instead, leverage Zoho's native capabilities for this integration.

• Release Notes | January 2026

  We have rolled out a set of powerful new enhancements across Zoho Vertical Studio that bring several long-awaited capabilities to your applications. These updates focus on deeper customization, smarter automation, better reporting, and improved usability

• How to charge Convenience fee OR payment gateway charges to the end client who is paying the invoice?

  Hello, I am creating this topic after having discussions with various sets of users and have understood that with people moving more and more to digital payments, it is important for the client to enable the "Convenience fee" kind of scenario. I have

• Card payment surcharge?

  Hi, I would like to offer my customers the ability to pay invoices by card (using the PayPal integration). However, PayPal charges me around 5% to receive a card payment, and I would like to pass on this cost to my customer by way of a card payment surcharge. Is there any way for Zoho Invoice to be set up to automatically add a defined "card processing fee", say 5% of the invoice total, if the customer elects to pay by card? I don't want to add this on to invoice manually, since most of my clients

• Automate Credit Card Surcharge

  Is there a way to create an automation that will add a 3.0% credit card surcharge to a subscription whenever a customer pays via credit card?

• Zoho Books | Product updates | January 2026

  Hello users, We’ve rolled out new features and enhancements in Zoho Books. From e-filing Form 1099 directly with the IRS to corporation tax support, explore the updates designed to enhance your bookkeeping experience. E-File Form 1099 Directly With the

• Notifications Feeds unread count?

  How do I reset the unread count on feeds notifications?  I've opened every notification in the list.  And the count never goes to zero.

• Zoho POS App Hanging Issue – Sales Becoming Difficult

  The Zoho POS app frequently hangs and becomes unresponsive during billing, making it very difficult to complete sales smoothly. This commonly happens while adding items, during checkout, or at payment time, especially during peak hours. These issues cause

• Tip #62- Exploring Technician Console: Send Ctrl + Alt + Del- 'Insider Insights'

  Hello Zoho Assist Community! Imagine you are a technician supporting a remote employee who cannot log into their system. The computer is stuck on the login screen after multiple attempts, and the user is unsure how to proceed. Instead of walking the user

• SKUs for Invoices, POs, etc.

  It doesn't appear that one can enable SKU display on invoices, POs, etc. This is problematic, and I don't see a good reason why this shouldn't be an option. Some of our vendors and customers use this in their system. Every other identifier code is available

• Introducing Bigin's Add-in for Microsoft Outlook

  Hello Everyone, Email is an important way to communicate with customers and prospects. If you use Outlook.com for emails and Bigin as your CRM, the Outlook Add-in helps you connect them easily so you can see your Bigin contact details right inside Outlook.com.

• how to avoid duplicate customer

  How can i avoid to create a duplicate customer. I charged a same customer with two different plans and it showed up twice in my customer list and subsequently in Zoho books contacts. It creates confusion to have a same customer appears multiple times in customer or contact list. How can i avoid it.

• RSC Connectivity Linkedin Recruiter RPS

  It seems there's a bit of a push from Linkedin Talent Solutions to keep integrations moving. My Account Manager confirmed that Zoho Recruit is a Certified Linkedin Linkedin Partner but does not have RSC as of yet., (we knew that :-) She encouraged me

• im facing issue on generate the Estimate price

  i couldn't understand what is the issue , i cant generate Estimate price where is the issue

• cannot be able to add user

  Dear team I tried to add a new user for sales team, but after entering the OTP its showing error message cannot add now

• Changing an existing item to different accounts & inventory-tracked

  Hi everyone, I have an item in Zoho Books that was originally set up as a non-inventory item. Over time, I associated it with different sales and purchase accounts, and I now have many invoices, bills, and reports that use this item. My business process

• New 2026 Application Themes

  Love the new themes - shame you can't get a little more granular with the colours, ie 3 different colours so one for the dropdown menu background. Also, I did have our logo above the application name but it appears you can't change logo placement position

• How do I edit the Calendar Invite notifications for Interviews in Recruit?

  I'm setting up the Zoho Recruit Interview Calendar system but there's some notifications I don't have any control over. I've turned off all Workflows and Automations related to the Calendar Scheduling and it seems that it's the notification that is sent

• Bookings duration - days

  Hi team, Is there any way to setup services/bookings that span multiple days? I am using Zoho Bookings for meeting room bookings. Clients may wish to book a room for more than one day, for up to a month.  If not, is there a plan to allow services to be setup with durations of Days as well as hours and minutes? Many thanks, Anna.

• Empty folders are now appearing in the sidebar...

  ...and the folder list is now auto-collapsed by default with no way to change. Neither of these recent updates are useful or user-friendly. ==================== Powered by Haiku https://www.haiku.co.uk ====================

• big 5 accounts

  how do you find what accounts are listed as Big 5 ?

• Zoho recruit's blueprint configuration is not functioning as mapped

  Current Status: Zoho Blueprint is not functioning as configured. Issue: We are moving a Candidate status in Zoho Recruit "for active file" but we encountered: "Status cannot be changed for records involved in Blueprint." This happens to various client

• Actual vs Minimum

  Hi all, I am sure I am not the only one having this need. We are implementing billing on a 30-minute increment, with a minimum of 30 minutes per ticket. My question is, is there a way to create a formula or function to track both the minimum bill vs the

• Delay in rendering Zoho Recruit - Careers in the ZappyWorks

  I click on the Careers link (https://zappyworks.zohorecruit.com/jobs/Careers) on the ZappyWorks website expecting to see the job openings. The site redirects me to Zoho Recruit, but after the redirect, the page just stays blank for several seconds. I'm

• How to add interviews through API

  I'm trying to add an interview without much luck. The documentation gives examples of adding just about everything except an interview. However, the issue might be the way I'm formatting it, because the documentation is unclear to me. It seems as if the xml should be passed in the url, which seems unusual. I've tried the data as both plain and character escaped, but nothing seems to work, nor do I even get an error response. https://recruit.zoho.com/recruit/private/xml/Interviews/addRecords?authtoken=***&scope=recruitapi&version=2&xmlData=<Interviews> <row

• Can't scroll the page down unless I refresh the page

  Hello, This issue has been going on with me and a lot of other users in my organization, we can't scroll down! the scrolling side bar doesn't appear and scrolling down through mouse or keyboard keys doesn't work, it seems that the page just ends in the

• Offer already made- but I withdrew it

  I made an offer letter, but made a mistake on it. I withdrew the offer but now I can't recreate the correct offer. Zoho keeps saying that "A same offer has already been made". I look in the "offers" and there are NO offers (this is the first time I've

• Control the precision of answer bot responses

  Hello everyone, Admins can control the precision with which the Answer bot analyzes and generates a response by adjusting the threshold levels. Based on predefined threshold values, Zia analyzes how closely the query matches with the available KB articles.

• Rebrand your CRM with the all-new custom domain mapping setup

  UPDATES TO THIS FEATURE! 19th Jan, 2024 — Custom domain mapping has been made available for portal users in Zoho One and CRM Plus. 23rd June, 2023 — Custom domain mapping has been made available for all users, in all DCs. Hello everyone! We are elated

• Add Israel & Jewish Holidays to Zoho People Holidays Gallery

  Greetings, We hope you are doing well. We are writing to request an enhancement to the Holidays Gallery in Zoho People. Currently, there are several holidays available, but none for Israel and none for Jewish holidays (which are not necessarily the same

• Sender Email ID is duplicate

  My sender id "automate@erplaunchpad.com" is coming as duplicate but I have not used it anywhere else please help

• CRM x WorkDrive: File storage for new CRM signups is now powered by WorkDrive

  Availability Editions: All DCs: All Release plan: Released for new signups in all DCs. It will be enabled for existing users in a phased manner in the upcoming months. Help documentation: Documents in Zoho CRM Manage folders in Documents tab Manage files

• Building Toppings #6 - Install and uninstall actions

  Hello Biginners! In our previous forum post, we explored creating connections - specifically, custom service connections in the Bigin Developer Console. In this post, we'll focus on another feature that can be used in every topping: install actions. We'll

• Next Page