Kaizen #29 - Parameters in Zoho CRM APIs [Part 1/2]
Hello everyone!
Welcome back to another week of Kaizen!
In this post, we will shed some light on the Parameters in Zoho CRM APIs.
What will you learn from this post?
In this post we will discuss the parameters in Get Records API. In our upcoming post, we will discuss parameters in Search Records API and other generic parameters available in Zoho CRM APIs.
Parameters in Get Records API
Parameters in Zoho CRM APIs allow you to filter records based on your needs. For instance, if you want to retrieve the records in a specific custom view, you can filter the results by adding a cvid parameter, with the unique ID of the custom view. Now, let us discuss about each parameter in detail. All the parameters that are listed below are optional.
a. fields
Use this parameter to retrieve the specific fields in the response, instead of the entire JSON file. For instance, if you want to retrieve just the Last Name and the Email ID of the Leads, you can use the fields parameter.
In the fields parameter, specify comma-separated API names of the fields that you want to retrieve.
Apart from the Get Records API, you can use this parameter in the Get Notes API.
b. sort_order & sort_by
Use these parameters to sort the records that you retrieve in either ascending or descending order. The system behaves differently, based on whether you have specified the sort_by field.
sort_order accepts the following string values:
- asc: To sort the records in ascending order.
- desc: To sort the records in descending order. This is the default value.
sort_by accepts valid module-specific filed API names.
Case 1: When you specify both sort_order and sort_by
If you specify both sort_by and sort_order field, the system sorts the records based on the value in the sort_by field in the order specified in sort_order parameter. In the screenshot below the records are sorted based on Email in descending order.
Case 2: If you specify only the sort_order
If you specify only the sort_order, the system sorts the records based on the unique ID of the record. In the screenshot below, the Leads are sorted based on "id" in ascending order.
Case 3: If you specify only the sort_by
If you specify only the sort_by, the system sorts the records based on the value in the sort_by field in descending order.
In the screenshot below, the Leads are sorted based on the value in the "No_of_Employees" field in descending order.
c. converted
Use this parameter to get the list of records based on whether they are converted or not. For instance, the Leads that were converted into Contact or Account (or) Quotes that were converted into Sales Orders or Invoices can be retrieved using this parameter.
The parameter accepts only boolean value:
- true: Retrieves converted records.
- false: Retrieves records that are not converted.
Supported Modules
Leads, Quotes
Apart from the Get Records API, you can use this parameter in the Search Records API.
d. approved
Use this parameter to retrieve the records involved in the approval process.
The parameter accepts only the boolean value:
- true: Retrieves records that are approved.
- false: Retrieves records that are still in the approval process.
Apart from the Get Records API, you can use this parameter in the Search Records API.
e. page & per_page
Use this parameter to retrieve records based on their position in the CRM. The default value for the page parameter is 1, and the per_page parameter is 200. You can retrieve a maximum of 200 records per API call.
For instance, let us assume that you need to fetch 400 records. Then, you need to make two API calls:
(i) With parameters page=1 and per_page=200
The request fetches the first 200 records in the Leads module.
(ii) With parameters page=2 and per_page=200
The request fetches records that are positioned from 201 to 400 in the Leads module.
The "more_records" key represents if there are more records present in subsequent positions in that particular module.
- true: There are more subsequent records in the module.
- false: There are no more records in the module.
Other APIs in which you can use page & per_page parameters:
f. cvid
Use this parameter to retrieve records in a custom view. Specify the unique ID of the custom view as value.
g. territory_id & include_child
Use this parameter to retrieve records in a specific territory. Specify the unique ID of the territory in the territory ID parameter, and specify whether you want to include child territories in include_child parameter.
include_child accepts only boolean value:
- true: Retrieves records in the child territory.
- false: Retrieves records only in the parent territory. This is the default value.
Note that Territory is supported only for the modules Deals, Contacts, and Accounts.
Refer to Kaizen #25 Zoho CRM API - Common Errors and Error Handling to know about the errors related to parameters.
We hope you found this post useful. Let us know your thoughts in the comment section or reach us out at support@zohocrm.com.
Cheers!
Previous 'Kaizen' - Use cases related to Record Owner
Next 'Kaizen' - Parameters in Zoho CRM APIs [Part 2/2]
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
Sneha Sridharan
Sticky Posts
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 areKaizen #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 #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 theKaizen #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.
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
Zoho Meeting Android app update: Breakout rooms, noise cancellation
Hello everyone! In the latest version(v2.6.1) of the Zoho Meeting app update, we have brought in support for the following features: 1. Join Breakout rooms. 2. Noise cancellation Join Breakout rooms. Breakout Rooms are virtual rooms created within a meetingiOS 12 update: Introducing autofill passwords and Siri Shortcuts in Zoho Vault
With this iOS 12 release, Zoho Vault users can now autofill usernames and passwords on Safari and other third-party apps. Users can enjoy a seamless login experience to their everyday apps without compromising security and also access passwords stored in Zoho vault with Siri Shortcuts by adding personalized phrases. How to enable autofill password on your iOS device? First, you need to update your device to iOS 12. Apple recommends you to take a backup before you update your device to the latestZoho Vault: A look at what's new for iOS, iPadOS, and macOS
Hi everyone, At Zoho Vault, we constantly aim to improve your security experience. Based on both internal and external feedback, we have recently rolled out updates across our iOS, iPadOS, and support for macOS platforms. Introducing the desktop app forBiometric Access Support on Zoho Vault Desktop App
Is there any plans to add biometric authentication (fingerprint, face recognition) for Vault desktop apps (Windows/macOS) to enhance security and ease of access. I would love to hear other members view on thisFree webinar: Learn the benefits of migrating to Zoho Vault's new interface
With remote work becoming more and more common across the globe, productivity and time management are now pivotal concerns for every organization. With the number of business applications employed by companies constantly increasing, a password manager like Zoho Vault saves a lot of productive hours for your team. Vault's new interface has been carefully designed to address these pressing needs, helping users increase their productivity while improving their overall online experience. This July,Free Webinar: An exclusive live Q&A session with the Zoho Vault team
As 2020 draws to an end, we're closing out a year that has seen drastic changes all around the world. Many businesses have adopted cloud solutions and a remote work culture for the first time, and this has given rise to newer cyber risks and threats thatWhy passwordless authentication should be your top security project for 2021
Hello users! We know that nobody likes to remember passwords, yet they form an indispensable part of our lives. Many of us working with any kind of technology today manage numerous passwords for personal and business accounts. With the widespread adoptionFree Webinar: See why Zoho Vault is the best alternative to LastPass
When LastPass was acquired by LogMeIn in Oct 2015, we expressed our genuine concern about how this would change the LastPass business model and how customer trust would transfer from one company to another. As we suspected, LastPass doubled their pricingManaging cyber threats when working remotely | A Customer Survey Report
The nearly universal adoption of remote work has changed the way businesses function. Globally, enterprises continue to work to find new ways to make life easier for employees working remotely. However, a commonly cited concern has been the lack of cybersecurityWorld Password Day: 5 interesting facts about passwords
It's World Password Day: that time of the year when we talk about password hygiene and the importance of safe password management. World Password Day is observed on the first Thursday of every May, and this year, we'd like to talk about some of the mostFree Webinar: Go passwordless in 2022 with Zoho Vault
Passwords have long been the preferred authentication method, largely due to their universal appeal. While they're easy for people to use and implement, they're also convenient for hackers to exploit. Reports from 2021 state that weak and stolen passwordsMyki has announced EOL for its services | Learn why Zoho Vault password manager is the best alternative
Hello Myki users, Myki has announced end-of-life for its Teams, MSP, and GUARD services, after being acquired by JumpCloud. In their recent announcement, Myki stated that they will be removing their apps and extensions from the respective stores, turningJoin our exclusive meetup with Zoho's Real Estate community
Hey there, The Zoho Vault team is conducting a meetup for all real-estate users from Zoho. During this session, we will be discussing the need for secure password management and how Vault can help you and your clients safely protect passwords and otherFree webinar: A quick walkthrough of Zoho Vault and major updates in 2023
Managing passwords is crucial for all businesses. You can securely store, share, and manage passwords effectively from anywhere with Zoho Vault. We have introduced several new features in 2023 to offer the best online experience for our users. Join ourFree webinar: Why a password manager is a “must-have” for everyone in 2024
In the past decade, we've witnessed numerous cybersecurity breaches globally, with a significant portion resulting from the "it won't happen to me" mindset. Shockingly, in 2023, 86% of breaches involved weak and stolen passwords. Password hygiene is crucialZoho Vault - Webinars 2023 - Video Recordings and Slide Decks
Hello, We wanted to offer a consolidated list of Zoho Vault webinar resources from 2023. Therefore, we're putting together a list that includes links to our webinar recordings and slide decks for easy access. Webinar Video recording Slide deck GettingFree webinar: Focal point: Building a financial ecosystem with Zoho Vault and Zoho Workplace
Hi everyone! Cyber threats against the financial sector are escalating. In the last two decades, nearly one-fifth of reported incidents targeted financial institutions, causing $12 billion in direct losses. Cybercriminals are becoming more sophisticated,New features in Zoho Vault
We’re thrilled to introduce a wave of powerful updates in Zoho Vault, designed to enhance security, streamline workflows, and improve your overall experience. Let’s dive into what’s new! Folder creation restrictions Limit who can create folders in yourJoin our World Password and Passkey Day expert Q&A 2025
Hey everyone! World Password and Passkey Day is almost here, and there's no better time to talk about something we all rely on daily—secure authentication. Did you know that a staggering 60% of hacking-related breaches are tied to weak or stolen passwords?Dashlane discontinued its free plan: Here's why Zoho Vault's free plan is worth the switch
Hey everyone, Dashlane password manager has officially announced that its free plan will be discontinued starting September 16, 2025. This change means that current free users will need to either upgrade to a paid subscription or export their data andIntroducing SecureForms in Zoho Vault
Hey everyone, Let’s face it—asking someone to send over a password or other sensitive data is rarely straightforward. You wait. You nudge. You follow up once, twice—maybe more. And when the information finally arrives, it shows up in the worst possibleClickjacking: Zoho Vault's Response
Issue: Password manager browser extensions are found to be vulnerable to clickjacking security vulnerabilities that could allow attackers to steal account credentials, TFA codes, and card details under certain conditions. Reported by: Marek Toth, IndependentFree webinar: Security that works: Building resilience for the AI-powered workforce
Hello there, Did you know that more than 51% of organizations worldwide have experienced one or more security breaches, each costing over $1 million in losses or incident response? In today’s threat landscape, simply playing defense is no longer enough.Free webinar—Redefining workforce security with Zoho Vault: Passwords, passkeys, and multi-factor authentication
Hi everyone! Did you know that in Q2 alone, 94 million data records were leaked globally? Behind every breach is a combination of poor password habits, phishing attacks, privilege misuse, and simple human error. The fallout—including reputational damage,Fill Colors
Hello, Just curious, is it possible to manage the Used and standard colors in the fill drop down menu ? I would like to change/edit them is possible to colors I frequently use. Thanks for you reply, BruceIs there a way to generate a virtual meeting for a group service in Zoho Bookings?
Are virtual meetings not supported for group services/meetings? I have integrated Zoom with one-on-one services, but I need a way to create an online group meeting. ThanksItems Below Reorder Point Report?
Is there a way to run a report of Items that are below the Reorder Point? I don't see this as a specific report, nor can I figure out how to customize any of the other stock reports to give me this information. Please tell me I'm missing something sClient scripts for Zoho Books ?
Good day everyone, I am looking for a way to be able to interact with the Quotes and Invoices as they are being created. Think of it like Zoho client script in Zoho CRM. But for the life of me I dont see a way to do this. The issue with having functionFillable template with dynamic tables?
Is there a way to build a fillable template so that users can add rows to a table? To describe what I'm trying to accomplish the table has 3 sections; a header row, some number of rows with custom information, and a summary row with totals. I can't figureInvoicing multiple expense items as a single line item
My client would like me to invoice them for multiple expense items on a single line item on an invoice. Can this be done? I know I can import billable expenses to an invoice, but I don't know how to show them as a single line item or have themZoho Books | Product updates | November 2025
Hello users, We’ve rolled out new features and enhancements in Zoho Books. From translating email notification templates to the new transaction locking restrictions, explore the updates designed to enhance your bookkeeping experience. Making Tax DigitalTables improvement ideas / features
Heya, I've been using Zoho Tables for a few months now and wanted to post some features that I think will be greatly beneficial for the tool: 1. Ability to delete a record in automation or move a record in automation. - Usecase: I move a record from oneAnnouncing offline payment modes for event tickets
Hello everyone, Collecting ticket payments from prospective attendees can be a tricky part of event planning. While Zoho Backstage has always allowed you to collect payments online as people buy tickets from your event microsite, we have now enabledGmail is ramping up its email sender policy from November 2025
Hello marketers, As you may be aware, Gmail introduced a guideline for bulk senders starting February 2024. If not, here's a quick refresher straight from Google: After this policy was announced first in 2023 and soft-implemented in February 2024, weDeluge Error Code 1002 - "Resource does not exist."
I am using the following script in a Custom Button on a Sales Return. Basically, the function takes the information in the sales return (plus the arguments that are entered by the user when the button is pushed) and creates a return shipping label viaItem images
Can we get an "On hover" expanded image for items please ?Ability to Create and Manage YouTube Video Chapters in Zoho Social
Hi Zoho Social Team, How are you? We would like to request an enhancement to Zoho Social that would allow users to create and manage YouTube video chapters directly within the platform. Currently, Zoho Social does not support manually adding chaptersWhat happens to my current site SEO if i opt for zoho creator?
I have an existing website and I need to use Zoho creators for the rapid creation of my webpage creation. Currently, my IT team is creating the web pages, but I am concerned about the SEO of my current website if I shift to zoho will i loose it all?Automatic Portal invite
We have numerous customers we move through a blueprint in deals, when they get to a certain point we need to give them portal access, how can this be done through deluge or a workflow?Preview Emails with Merge Fields before sending
Hello, Are there plans to preview an email with merge fields before sending out? Currently, all you see in the preview are the merge field values, but before I send out the email I want to make sure the merge is working. Also, the saved emails only showNext Page