Kaizen #165 : How to call Zoho CRM APIs using Client Script
Welcome back to another exciting Client Script post!
In this post, we will discuss one of the most frequently asked questions: How do you call Zoho CRM APIs from Client Scripts?
In this kaizen post,
1. Ways to make calls to Zoho CRM APIs using Client Script
1.A Client Script ZDK CRM APIs
1.B. Using Connections
2. Requirement
3. Solution
3.A. Create a Connection
3.B. Invoke API using Client Script
4. Summary
5. Related Links
1. Ways to make calls to Zoho CRM APIs using Client Script
1.A Client Script ZDK CRM APIs
- You can use the available Client Script ZDK CRM APIs to call v2 APIs directly from within your Client Script.
- To view this documentation, click on the help icon next to CRM API in the Library Section of the Client Script Editor. Here is how the screenshot of the documentation looks.
- Here is the screenshot of documentation on Client Script ZDK CRM APIs.
- Note that this will also affect your API credit limits.
1.B. Using Connections
For calling other Zoho CRM APIs(other than the APIS covered in Client Script's ZDK CRM API) or third-party services, you will have to use Connections along with Client Script. In this post, let us see how to call Zoho CRM APIs. Check the Kaizen post on Third Party Integration using Client Script to know how to call Third Party APIs from Client Script.
2. Requirement
To retrieve all open deals for the currently viewed account.
3. Solution
To fetch app open deals for an account, you can use COQL API. You can also use the Related Records API, get deals of a given account ID, and then filter the open deals.
But COQL API is recommended due to the following reasons.
- There is no indexing delay.
- You can use comparators such as is null, is not null, between, in, not in, like, and not like in your search query.
- You can fetch data from other lookup modules if any. Click this Kaizen Post for more details.
To accomplish this requirement, create a connection with the scopes for the API you want to call and create a Client Script
3.A. Create a Connection
- To setup Connection, follow the below steps.
- In Zoho CRM, go to Setup → Developer Hub → Connections and click "Create Connection".
- Select Zoho OAuth in Default Services and click "Create and Connect".
- Specify a name for the Connection and select the Scopes required for COQL API.
ZohoCRM.coql.READ (and) ZohoCRM.modules.READ(or)ZohoCRM.modules.{module_name}.{operation_type}
- Click Create and Connect.
3.B. Invoke API using Client Script
- Go to Setup → Developer Space →Client Script. Click +New Script.
- Specify the details to create a script and click Next.
- Enter the following script and Click Save.
- var acc=$Page.record_id;
- var parameters = {
- "select_query": `SELECT Stage,Account_Name.id from Deals where Stage not in ('Closed Lost','Closed Won','Closed - Lost to Competition') and Account_Name.id = ${acc}`
- };
- var response = ZDK.Apps.CRM.Connections.invoke("test", "https://www.zohoapis.com/crm/v6/coql", "POST", 2, parameters, {});
- log(JSON.stringify(response));
- You can invoke COQL API using Connections in Client Script using invoke() method.
Click here to know more about the Connections.
Here ,
- Connection name is test
- url is https://www.zohoapis.com/crm/v7/coql
- method is POST
- param_type is 2
- parameters is the query stored in parameters variable.
- headers - there are no headers in this case.
Summary
In this post we have discussed the following.
1. How to call COQL API using Client Script
2. Steps involved to include the scopes via Connection
3. Advantages of COQL API
Related Links
- Creating a Client Script
- Client Script Events
- Client Script IDE
- Use cases of Client Script
- Best practices of Client Script
- Query 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
Maadhari M
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
Pushing to Shipstation from Zoho
I know there are four triggers in Flow for integration with Shiptation when something happens in Shipstation. What options do I have, if any, for pushing data TO Shipstation from Zoho?Integration with ShipStation
Any plans to integrate flow with Ship station? My scenario: When a sales order is fully picked order details get pushed to Ship station so shipping label can be created. Ideally then tracking number would be pushed back to order. ThanksCan't Remove Payment Gateway
I am getting the error "Settings cannot be cleared as some of the transactions are still in progress." when trying to remove the PayGate payment gateway which I was unable to get working. I am now using paystack and I want to remove Paygate.Sync specific Zoho Inventory Warehouses to Zoho Commerce
As said in the title, we would want to only sync stock from one warehouse of Zoho Inventory to the Zoho Commerce item stock. We have a 2 warehouses in different countries and the way that Zoho Commerce works (It takes stock from ALL WAREHOUSES EVERYWHEREWeekly Tips : Automatically clean clutter with Junk cleanup interval
If you regularly receive many unwanted or spam emails, your Spam folder can quickly fill up and start taking up valuable storage space in your Zoho Mail account. Instead of manually clearing it every few days, you might find it helpful to enable automaticAny solution for getting portal users list in deluge or in widget
Hi Team, Has anyone able to find the solution to get portal users list in deluge or in zoho creator widgets? Thanks, PayalThe Grid is here!
Hey Zoho Forms Community! 👋 We’re thrilled to announce the launch of a feature that’s been on your wishlist for a while: Grids What is Grids? Grids let you place form fields side by side in multiple columns to create a more concise and organized formGraphQL in new Send Webhooks feature
Hello, is it possible to use GraphQL apis in the new Send Webhooks feature?# 2 Why do we need a billing system when accounting covers billing?
In today's evolving financial tech stack, businesses use a mix of tools to manage their day-to-day operations, from invoicing to full-fledged accounting. While accounting platforms typically come with built-in invoicing features, specialized billing systemsHow to insert an Excel/Zoho Sheet table in a chat?
Hello, is there a way to paste an excel/zoho sheet table to a conversation without loosing table lines. I tried to paste a piece of a table and all the columns and rows were gone. How to easily paste a table without a need of sending a file? KatarzyMass Update Application Status
How to update application statuses of Multiple Applications at once? Is that possible? If not then why please consider adding it It can save hours of manual work Thats the only Option I seeFree webinar: Streamlining customer service paperwork with the Zoho Sign extension for Zoho Desk
Hi there! Wondering how to bridge the gap between digitized customer service and business paperwork? Attend our free webinar to learn how you can do this by connecting Zoho Sign, our digital signature app, with Zoho Desk, our online customer service helpMail Search Not Working
Hello, Mail search is not working at all. I've tried Chrome and Mozilla. I can try and search for an exact term, or even an email that is 1st in my email list. All search does is sit and spin, or it comes up with no results. I've also tried it on my androidCannot Send Email to a Gmail Account
Hello, I have a zoho-hosted email account, alex@chirochannelnetwork.com that has trouble sending to gmail accounts. But not all gmail accounts, only some of them. I've tried to figure this out with clients, and they don't appear to be going into theirUnblock ME
info@pentekykloi.gr Unable to send message;Reason:554 5.1.8 Email Outgoing Blocked. Learn more. I purchase additional storageCannot Print Landscape with Zoho Sheet
I am noticing that when using the Zoho Sheet desktop for Mac, that even when selecting landscape as the print option, once you choose "Print", a second system dialog opens that automatically makes the view portrait again, and does not allow printing inPower of Automation : Enhancing custom date field calculations by excluding Weekends and Holidays
Hello Everyone, A Custom function is a user-written set of code to achieve a specific requirement. Set the required conditions needed as when to trigger using the Workflow rules (be it Tasks / Project) and associate the custom function to it. Requirement:portal.assignUserInProfile - Não esta adicionando
Estou encontrando problema com este comando portal.assignUserInProfile Não esta incluindo o usuário no portal Alguém pode me dizer o que pode ser thisapp.portal.assignUserInProfile("teste@gmail.com","Customer");CRM emails vs Campaigns
Please help me understand this. I am having a difficult understanding of "Campaigns" sent through CRM (real emails) or Zoho One (blast "potentially junk" emails) This is what I currently think emails sent via CRM are "real" emails sent through linked real personal email accounts and therefore are more likely to get delivered. We use this for critical updates for our "Approved " accounts and certain other preferred statuses emails via Campaigns are sent through the Zoho server (like MailChimp, CampaignReverse proxy
We have a web application in the creator platform. When I launch a particular DNS, I would like that DNS to redirect to the web page of the application in creator app. Has anyone achieved it and if yes, please share how to do it.Still client need to download .exe?
Hello, the client for use zoho assist need everytime download .exe file and launch it?Splitting a ticket's entire thread
Hi, When you split a ticket it only splits the individual reply that you clicked "Split as new ticket" on. Is it not possible to split the entire ticket thread from that point into the new ticket (every reply from the split point forward)? Or is thereEditing the text on the Help Center home page
Is it possible to edit the "Welcome to Help Center" message anywhere? This one: We'd like to be able to tailor it a little more ourselves.WHMCS for Zoho Flow
Can we use WHMCS for Zoho flow?Online meetings through Calendar Booking form with options
This is great to see and particularly for those users who don't have Zoho BOOKINGS. The shame of it all though is that it could have been better. Why do we have to set up separate booking forms for each type of meeting and for each online conferencingAgents permission per department
Hi Team, can I setup permission for each agent what they can do in each department, for example I want account department agents to only have view access to support department tickets and not allowed to assign or reply to clients. I am sure this wouldCRM notes
I want to be able to add notes to a task that do not necessarily get rolled up into an account or contact. For example, I tasks to work on a Court Order for John Doe divorce account. There might be lots of updates (in the form of notes) that employeesAlternative / optional Position
How do you create an alternative position or an optional position (article) in offers?جمود في الصفحة عند حفظ عمل
عندما اقوم باضافة ايقونة الى صفحة النموذج تجمد الصفحة ولا تعمل وتصبح مثل المظلة احدث الصفحة لا تعمل انتظر قليلا لا تعمل اقوم بنسخ رابط الصفحة والصقه في الرابط فيعملZOHO Books Canadian payroll Integration
Hello, I know ZOHO books doesn't have Canadian payroll and I dont believe its coming anytime soon. My question is there a Canadian payroll software that could be integrated with Zoho Books? Thank you HDZoho Desk Time Tracking and the Salary Privacy Issue
Hello colleagues, Just wondering if anyone did hit the same wall? In the Desk, when the agent-specific hourly rates are enabled (Zoho Desk → Setup → Time Tracking → Billing Preferences), these Time Entries are being displayed in the Ticket History tab.How to Delete, Disable, or Remove Streams from the Mail App?
Is there a way to remove Streams from the mail app sidebar? I get too many notifications, it doesn't add any value to Zoho's functionality (especially since you can just make comments inside an email), and is distracting. I do not want notifications/alertsDelay in MX updates
Hi, I set MX Records 12 hours ago, and I am receiving email normally, but I still get notification MX record is not pointing correctly. Error: The MX records of your domain is not yet pointed to Zoho Mail. Why there is a delay in detecting MX records,make.com integration
Just wondering if anyone on Zoho One account connecting apps to Make.com We're on Canadian server (.com) and when connecting to Make.com, it keeps having error of Invalid Client ID. I have contacted both Zoho and Make and both sides said it's not an errorArticle Numbers for KB articles
Hello, I was wondering if it's possible to turn on article numbers/ part numbering for KB articles. If this is not already a feature, we'd like to request it. Frequently a solution will require multiple articles so tracking which articles are referencedRefund Request ,Zoho Mail Subscription (zoho suport is not replying)
Hi Zoho Team, I recently subscribed to the Zoho Mail yearly plan, but after evaluating it, I found that the interface does not suit my workflow. I’ve already canceled the subscription from my end. As I’m well within your 30-day refund window, I’m requestingFile Encryption - Zoho Desk iOS app update
Hello, Everyone! We have now introduced the 'File Encryption' option within the Zoho Desk app as part of the HIPAA Compliance. This option allows the user to encrypt the attachments within the Desk mobile app, which acts as an additional layer of security.Data encryption - Zoho Desk iOS
Hello, Everyone! In the recent iOS version(v2.8.23) of the Zoho Desk app, we have supported data encryption. As a part of HIPAA Compliance, the Zoho Desk mobile app now allow users to encrypt the Desk mobile database as an additional layer of security.Notify Admin when a user forgets to check-in or check-out at the designated time.
Hello, I would like notify the Admin via email when a user forgets to check-in or check-out at the designated time. What is the best way to setup this email notification?Assistance Needed with Prospect Conversion Issue
Hi, I attempted to convert a prospect to an account, but received a pop-up notification indicating that the contact information matches an existing contact. I selected the option to add it to the existing contact, but it appears the prospect was not successfullyNext Page