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
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
Sneha Sridharan
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
Zoho Books - France
L’équipe de Zoho France reçoit régulièrement des questions sur la conformité de ses applications de finances (Zoho Books/ Zoho Invoice) pour le marché français. Voici quelques points pour clarifier la question : Zoho Books est un logiciel de comptabilitéEditing a bundle
How can I edit a bundle?Approval escalation
Hi I would like to have an approval escalation if Approver 1 does not approve/reject a request with a certain SLA. Currently I have a status field that changes to "Pending approver 2 approval" after a certain time, however the challenge I am faced withReferral module for our Zoho People employees
I have been requested to create a user in Zoho Recruit for each Zoho People user to allow them to refer a candidate in Zoho Recruit. Only the interviewer and guest profiles are free. The use of a custom profile is on the paid basis. Any user linked toConflicts on zoho project Tasks
Hi We want to use ZOHO Project for scheduling our technicians. We have maintenance contract with our customers. We schedule interventions on customer sites. So we created projects for each contract and task for interventions. So if a technician need to go to customer I create task and schedule them after depending of availibility. When I need to assign a date I use start Date and due date on the task. But I realized there is no conflict management. I called support and they told me it is not developped.Upcoming webinar : Build high-converting sales pipelines with Zoho LandingPage and Bigin
For small businesses, generating leads is only half the battle. The real challenge is staying organized, following up consistently, and turning those leads into customers. Join us for this webinar to learn how Zoho LandingPage and Bigin can help you createNew UX Improvements in the Zoho Expense iOS and Android Apps
Hello users, We're excited to share the latest updates and enhancements we've made to the iOS and Android apps of Zoho Expense. These updates have been designed to make your day-to-day expense and travel management even simpler. Note: We will be rollingUser Permission Log
Our external auditors are asking for a way to view changes made to user permissions (basically, a user permission change log). Is this feature built into Creator?What's New in Zoho Billing | May 2026
We're back with another round of updates in Zoho Billing! This month brings new capabilities designed to give you more flexibility and control over your billing operations. From associating price lists with business locations, and including annexuresZOHO SURVEY to ZOHO CRM integration
I am trying to use the ZOHO SURVEY to ZOHO CRM integration but the integration won't allow me to choose a record layout and that means there is a erquired field that i cannot input, is there any way around this?Why don't Zia agents support file uploads?
I am trying to build a Zia Agent that allows uploading of a PDF file and uses the GLM5 model to process it and extract information. But agents.zoho.com has no way to enable file uploads on the agent. Additionally, GLM5 based agents keep outputting theirZoho Forms - Failed CRM Sync Improvement
I'd like to suggest an enhancement to the Zoho Forms and Zoho CRM integration. Currently, once a form entry has been submitted, there is no simple way to push that individual entry to CRM again if needed. Before anyone mentions it, I am aware that theHow to show product cards in your chatbot
Hey everyone, If you are using Guided Conversations to help customers find products, you have probably run into this problem: the bot gives customers a list of options, but they still have no idea which one to pick. There will be no images, no specs,"Make online" not clearing previously downloaded files from disk
I downloaded a large folder via "Make offline" so I could copy it to another location. This worked. When I was done I hoped that "Make online" would restore it to the previous state where those files are not stored locally in TrueSync. This did not work—FinderImporting Tasks
Few suggestions that would make creating project templates more efficient. 1. Having the ability to import tasks from a spreadsheet within the Project Template Task section. You can do this when creating a "new project." 2. When importing Tasks from a spreadsheet, to be able to associate a milestone to a tasklist, just as I can associate a tasklist to a task. This would alleviate a very tedious, time consuming process. 3. Another feature that would be very helpful is rather than a start and endGSTIN Public Search API
Does zohobooks have an api using which i can search GST numbers and get their details?Zoho Books | Product updates | April 2026
Hello users, Welcome to our April 2026 product updates roundup! Highlights include profit margin for sales transactions, insights in reports, recording deposits from undeposited funds in banking, and faster production workflows with improved assemblyQuotes Module - import data
Hello Zoho, is it possible to import Quotes records? I was trying and i have no results. Raport shows no data imported. Could you help me please how to do it?Spell Check Red Underlines Keep Appearing Even After Disabling
Hello Zoho Support, I'm facing an issue in Zoho Writer where red spell-check underlines keep appearing even after I disable Spell Check. I have already: Turned OFF Spelling Errors Turned OFF Grammar Turned OFF Writing Quality Turned OFF browser spellIts 2022, can our customers log into CRM on their mobiles? Zoho Response: Maybe Later
I am a long time Zoho CRM user. I have just started using the client portal feature. On the plus side I have found it very fast and very easy (for someone used to the CRM config) to set up a subset of module views that make a potentially extremely usefulTruco del mes: Zoho Desk - Cómo mostrar tarjetas de producto en tu chatbot
¡Hola a todos! Si utilizas Conversaciones Guiadas (Guided Conversations) en Zoho Desk para ayudar a los clientes a encontrar productos, probablemente te hayas encontrado con este problema: el bot ofrece una lista de opciones, pero los clientes siguenCliq iOS can't see shared screen
Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? RegardsRetail Payment Receipt
Hi, So "payment receipts" have a "Retail" template for thermal printers, but the template is configured at A4 paper size!!! How is this retail guys? On the other hand, Invoices have 3 Retail templates which have 3 and 4 inch paper size, perfectly fittingAssign default Location + warehouse to Customer / Vendor
Hello there. With the introduction of Locations I'm having to enter the warehouse for every single transaction which is getting really tiring and causes errors (easy to fix, but still). Does anybody know if there's a way to assign a default Location andSalesIQ : Allow Operators to Manually Set Company Names in Visitor Info
Hi SalesIQ Team. We have identified an issue where the Company name displayed in Visitor Info is sometimes incorrect or not displayed at all. Currently, there is no way for operators to manually edit or specify the company a visitor belongs to. I understandHow 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 have404 error at checkout
Our customers are getting a 404 error at checkout. Anyone else with the same problem?Enhancement in Zoho CRM: Introducing New Return Types for String Fields Based on Character Length
Dear Customers, We hope you’re well! In Zoho CRM, formula field with string return type is used in various scenarios where text is involved like concatenating customers’ first and last names, trimming characters from texts, performing find and replaceBUG and HANGUP - Add Row with Fields DOUBLES the amount of rows instead of Adding Just 1 Row
As it says in the title, there is a bug with forms generated with Zoho Writer where the Add Row With Fields ends up DOUBLING the amount of rows instead of Adding just 1 row.Approval Escalation based on time.
How can I configure a multi-approval in Zoho creator. I want to have 2 approvers, say team lead and line manager. I want prices less than 50 to go to the team lead, otherwise they should to the line manager. Also if the price is 50 but the team lead takesZoho Analytics "Esc" key problem
I frequently use the Escape (Esc) key while building dashboards, reports, and writing SQL queries. Since the recent updates to Zoho Analytics, the Esc key no longer behaves as expected. When writing SQL queries, pressing Esc to dismiss a suggestion nowAll new Address Field in Zoho CRM: maintain structured and accurate address inputs
Availability Update: 29 September 2025: It's currently available for all new sign-ups and for existing Zoho CRM orgs which are in the Professional edition exclusively for IN DC users. 2 March 2026: Available to users in all DCs except US and EU DC. 24Error when subscribing to any iCal feed in Group Calendar
When I try to add any iCal URL via Settings → Calendar → Calendars → Group Calendars → Manage → Subscribed by Group, Zoho pops up an ‘Internal Server Error’ and nothing is added in the ‘Subscribed by Group’ list. But - the feed then appears under my personalRecord Limit on Report
I have set up a report that I'm putting on a "page". I have filters set up to only show the records with deadlines in the next 45 days. But I only want the report to show the first 3 records (and if possible have a pagination option at the bottom to accessProblem with the blueprint flow.
Scenario: 3 departments in a single environment: A-B-C agents from department 1 D-E-F agents from department 2 G-H agents from department 3 Since we've been using Zohodesk (2023), agents can assign tickets to the correct department using the blueprintZoho ERP | Product updates | June 2026
Hello users, We launched Zoho ERP on January 23, and since then, our goal has been to help businesses streamline and manage their operations with greater efficiency, flexibility, and control. Since the launch, we've continued to enhance the platform everyKaizen #125 Manipulating Multi-Select Lookup fields (MxN) using Zoho CRM APIs
Hello everyone! Welcome back to another week of Kaizen. In last week's post in the Kaizen series, we discussed how subforms work in Zoho CRM and how to manipulate subform data using Zoho CRM APIs. In this post, we will discuss how to manipulate a multi-selectZoho CRM upload files error
Since today, we have been experiencing issues with uploading photos to opportunities. The message indicates that the storage is full, but as far as I can see, there is still plenty of space available. Could there be an issue or a bug?Mise à jour de Zoho Books – France
Chers clients, Merci pour votre patience et votre soutien continu. Avec les évolutions réglementaires à venir en France nous introduisons de nouvelles fonctionnalités dans Zoho Books pour les clients français. Ces mises à jour ont été conçues pour répondrePlease Make Zoho CRM Cadences Flexible: Allow Inserting and Reordering Follow-Up Steps
Sales processes are not static. We test, learn, and adapt as customers respond differently than expected. Right now, Zoho Cadences do not support inserting a new step between existing follow-ups or changing the type of an existing primary step. If I realizeNext Page