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
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
2. To fetch records from the Leads module whose Last_Name is '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 |
|
|
|
|
5000 |
| Not possible to fetch more than 2000 records |
|
|
10000 |
| Not possible to fetch more than 2000 records |
|
|
15000 |
| Not possible to fetch more than 2000 records | Not possible to fetch more than 10000 records |
|
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
Access your files securely from anywhere
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
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
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 thisKaizen #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 howKaizen #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
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
Full Context of Zoho CRM Records for Zia in Zoho Desk for efficient AI Usage
Hello everyone, I have a question regarding the use of Zia in Zoho Desk in combination with CRM data. Is it possible to automatically feed the complete context of a CRM record into Zia, so that it can generate automated and highly accurate responses forKnowledge base printing
I saw a posting about printing the knowledge base as I was looking for the answer, but we would like the ability to print out the entire knowledge base with a click, keeping the same organization format. Bonus would include an index of keywords andSearch not working!
I have items in my notebook tagged but when I search for a tag nothing comes up! Any fix for this?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 theUpdates for Zoho Campaigns: Merge tag, footer, and autoresponder migration
Hello everyone, We'd like to inform you of some upcoming changes with regard to Zoho Campaigns. We understand that change can be difficult, but we're dedicated to ensuring a smooth transition while keeping you all informed and engaged throughout the process.File Upload field not showing in workflow
Hi, I have added a field on Zoho CRM. I want to use it in a workflow where that particular field is updated based on another field, however it is not showing up in the field list to select it in the workflow. Why is this please?Drag 'n' Drop Fields to a Sub-Form and "Move Field To" Option
Hi, I would like to be able to move fields from the Main Page to a Sub-Form or from a Sub-Form to either the Main Page or another Sub-Form. Today if you change the design you have to delete and recreate every field, not just move them. Would be nice toHow do i integrate google analytics to Zoho Campaigns?
Looking to track Zoho Traffic from email Current topic is outdatedHow do teams manage meeting follow-ups across Zoho tools?
We’re using Zoho tools for collaboration and tracking, but managing meeting notes, action items, and follow-ups across teams is still challenging. Curious how others are handling this within Zoho workflows. Are there best practices or integrations thatAdding a Deal to and Existing Contact
I want to easily add a Deal to an existing Contact. If I click on New Deal on the Contact page this currently this is what happens: All of the mandatory field (and other field) information exists within the Contact. Is there a simple way for it to automaticallyZoho Sprint Backlog View, filter by item status
Hello, In Zoho Sprints, it would be great to be able filter out specific items in the Backlog based on their status. We would like to track items that were Removed from our backlog without seeing them constantly in the Backlog view, as this view shouldCustomize Colors used on graphs and charts according to users desire.
It would be great if we could customize the graph's colors as we see fit. I hate that yellow is always the default color!Let us view and export the full price books data from CRM
I quote out of CRM, some of my clients have specialised pricing for specific products - therefore we use Price Books to manage these special prices. I can only see the breakdown of the products listed in the price book and the specialised pricing forMejoras urgentes para ZOHO MEETING
Tengo unos meses usando Zoho Meeting. En general, es buena, pero hay cosas vitales que no logra cumplir con mínima calidad. 1) Calidad de audio y video: urge mejoras. Audio con retraso, imagen borrosa, mal recorte de silueta con fondos virtuales. Además,Multiple header in the quote table???
Hello, Is it possible in Zoho CRM to add multiple headers or sections within the Quote product table, so that when the quote is printed it shows separate sections (for example “Products” and “Services”)? To clarify, I’m asking because: This does not appearSaving sent email campaign as PDF
I'm looking to add all campaigns sent to an archive folder in sharepoint. Is there anyway to accomplish this in Zoho Flow ? I'm falling at the first hurdle ... can I automatically save a sent campaign as a PDF to a folder location ?Exporting All Custom Functions in ZohoCRM
Hello, All I've been looking for a way to keep about 30 functions that I have written in Zoho CRM updated in my own repository to use elsewhere in other instances. A github integration would be great, but a way to export all custom functions or any wayHow can Data Enrichment be automatically triggered when a new Lead is created in Zoho CRM?
Hi, I have a pipeline where a Lead is created automatically through the Zoho API and I've been trying to look for a way to automatically apply Data Enrichment on this created lead. 1) I did not find any way to do this through the Zoho API; it seems likeConditional Layouts On Multi Select Field
How we can use Conditional Layouts On Multi Select Field field? Please help.Make CAMPAIGNS email look as simple as possible
Hi there I'm trying to make my Campaigns email look as much like a normal email as possible. I'm a bit stuck with the "justification" of the email email block. Can I LEFT JUSTIFY the "whole email" to make it look "normal"? (Please see screenshot attached)Appreciation to Qntrl Support Team
We are writing this topic to appreciate the outstanding level of support from Qntrl Team. We have been using Qntrl since 2022 after shifting from another similar platform. Since we joined Qntrl, the team has shown a high level of professionalism, support,How can I hide "My Requests" and "Marketplace" icon from the side menu
Hello everybody, We recently started using the new Zoho CRM for Everyone. How can I hide "My Requests" and "Marketplace" from the side menu? We don't use these features at the moment, and I couldn't find a way to disable or remove them. Best regards,Whatsapp Integration on Zoho Campaign
Team: Can the messages from Zoho Campaign delivered through Whatsapp... now customers no longer are active on email, but the entire campaign module is email based.... when will it be available on whatsapp.... are there any thirdparty providers who canQuotes Approval
Hey all, Could you please help in the following: When creating quotes, how to configure it in a way, that its approval would work according to the quoted items description, not according to quote information. In my case, the quote should be sent to approvalMandatory Field - but only at conversion
Hello! We use Zoho CRM and there are times where the "Lead Created Date & Time" field isn't populated into a "Contractor" (Account is the default phrase i believe). Most of my lead tracking is based on reading the Lead Created field above, so it's importantDifferent Task Layouts for Subtasks
I was wondering how it would be possible for a subtask to have a different task layout to the parent task.Enable Free External Collaboration on Notecards in Zoho Notebook
Hi Zoho Notebook Team, I would like to suggest a feature enhancement regarding external collaboration in Zoho Notebook. Currently, we can share notes with external users, and they are able to view the content without any issue. However, when these externalUsing data fields in Zoho Show presentations to extract key numbers from Zia insights based on a report created
Is it possible to use data fields in Zoho Show presentations along with Zoho Analytics to extract key numbers from Zia insights based on a report created? For example, using this text below: (note that the numbers in bold would be from Zia Insights) RevenueFree webinar: AI-powered agreement management with Zoho Sign
Hi there! Does preparing an agreement feel like more work than actually signing it? You're definitely not alone. Between drafting the document, managing revisions, securing internal approvals, and rereading clauses to make sure everything still reflectsWhatsApp Channels in Zoho Campaigns
Now that Meta has opened WhatsApp Channels globally, will you add it to Zoho Campaigns? It's another top channel for marketing communications as email and SMS. Thanks.CRM For Everyone - Bring Back Settings Tile View
I've been using CRM for Everyone since it was in early access and I just can't stand the single list settings menu down the left-hand side. It takes so much longer to find the setting I need. Please give users the option to make the old sytle tile viewLets have Dynamics 365 integration with Zohobooks
Lets have Dynamics 365 integration with ZohobooksAdd notes in spreadsheet view
It would be great if we could Add/edit notes in the spreadsheet view of contacts/leads. This would enable my sales teams to greatly increase their number of calls. Also viewing the most recent note in the Contact module would also be helpful.Boost your Zoho Desk's performance by archiving tickets!
The longer your help desk operations are, the more likely it is to accumulate tickets that are no longer relevant. For example, ticket records from a year ago are typically less relevant than currently open tickets. Such old tickets may eventually leadOpening balances - Accounts Receivable and Payable
Our accounting year starts on 1st August 2013 and I have a Trial Balance as at that date, including Accounts Receivableand Accounts Payable balances, broken down by each customer and supplier. Q1 - do I show my opening balance date as 31st July 2013 orAnnouncing Kiosk 1.1 - Customize screen titles, configure new fields & actions, use values from your Kiosk to update fields, and more.
Hello all We are back again with more enhancements to Kiosk. So what's new? Enhancements made to the Components Add titles for your Kiosk screens and adjust its width to suit your viewing preferences. Three new fields can be added to your screen: Percentage,Limited System because of Limited Number of Fields for Car Dealership
Dear Zoho Support, we want to have all the information about a car inside of a car record. We want to have Zoho CRM as our single source of truth for our data, but the limited number of fields are not allowing that. The data consist of: technical dataCancel Subscription
Hi , Im want to cancel my account but without success please help me to do itMaking an email campaign into a Template
I used a Zoho Campaign Template to create an email. Now I want to use this email and make it a new template, but this seems to be not possible. Am I missing something?Direct Access and Better Search for Zoho Quartz Recordings
Hi Zoho Team, We would like to request a few enhancements to improve how Zoho Quartz recordings are accessed and managed after being submitted to Zoho Support. Current Limitation: After submitting a Quartz recording, the related Zoho Support ticket displaysNext Page