Kaizen #149: Using GraphQL APIs to fetch data in a consolidated way

Hello everyone!

Welcome to this week's post in the Kaizen Series! This week, we will discuss GraphQL APIs, a query language that provides an efficient, powerful, and flexible method for fetching and manipulating data from Zoho CRM.

Let us consider the scenario of a large industrial equipment manufacturer,  Zylker Manufacturing.  They utilize Zoho CRM to streamline their sales processes and customer relationship management. Their sales support team uses a legacy system to manage their activities. When a contact seeks support, the support team must have access to the latest data from Zoho CRM to assist them better. They need:

• details of the contact, such as email, phone, and Account details
• details of the ongoing deals of the contact, including potential revenue and stages .
  

With GraphQL APIs, with a single API call, you can create custom unified view that combine information from multiple Zoho CRM modules. This allows the support team to view all relevant information in one place, making it easier to manage sales processes and customer interactions. To create the view, metadata of the fields is also required.  This structured approach in GraphQL allows Zylker Manufacturing to efficiently aggregate data.

You need to construct a GraphQL query to fetch specific data related to a contact and associated deals, as well as metadata about the fields in the Contacts and Deals modules. Let's break down each part of the query that can achieve this.

1. Fetching Contact and Deal Information

Records: Records comprises the records from the different Zoho CRM modules. Contacts: Specifies that we want to query the records of the Contacts module. The where clause filters the contacts based on their email address. _data: This indicates the fields we want to retrieve from the records. In this case: Email: Fetches the email of the contact. Full_Name: Fetches the full name of the contact. Deals__r: Fetches the related deal record of the Contact.  Expected_Revenue: Fetches the expected revenue from each deal. Deal_Name: Fetches the name of each deal. Stage: Fetches the current stage of each deal.

Records {     Contacts(where: { Email: { equals: "krismarrier@noemail.com" } }) {         _data {             Email {                 value}             Full_Name {                 value}             Deals__r {                 _data {                     Expected_Revenue {                         value}                     Deal_Name {                         value}                     Stage {                         value                     }}}}}}

2. Fetching Metadata for Contacts

Meta: This fetches the details of the metadata for Contacts module. It uses the alias "contact_meta" Modules(filter: { api_name: "Contacts" }): Specifies that we want to fetch the metadata of the Contacts module. _data: This indicates the fields we want to retrieve. In this case: id: The unique identifier for the module. api_name: The API name for the module. module_name: The name of the module. description: The description of the module. plural_label, singular_label: Labels used for the module. fields: Retrieves metadata for specific fields within the module. filter: { api_names: ["Last_Name", "Email"] }: Specifies which fields' metadata to retrieve.For each field, it retrieves: id: Field identifier. api_name: API name for the field. display_label: The display name of the field. json_type: The data type as represented in JSON. data_type: The Zoho CRM data type of the field.

contact_meta: Meta {     Modules(filter: { api_name: "Contacts" }) {       _data {         id         api_name         module_name         description         singular_label         plural_label         fields(filter: { api_names: ["Last_Name", "Email"] }) {           _data {             id             api_name             display_label             json_type             data_type           }         }       }     }  }

3. Fetching Metadata for Deals

Meta: This fetches the details of the metadata for Deals module. It uses the alias "deal_meta" Modules(filter: { api_name: "Deals" }): Specifies that we want to fetch the metadata of the Deals module. _data: This indicates the fields we want to retrieve. In this case: id: The unique identifier for the module. api_name: The API name for the module. module_name: The name of the module. description: description of the module. plural_label, singular_label: Labels used for the module. fields: Retrieves metadata for specific fields within the module. filter:  api_names: ["Expected_Revenue", "Deal_Name","Stage"] }: Specifies which fields' metadata to retrieve.For each field, it retrieves: id: Field identifier. api_name: API name for the field. display_label: The display name of the field. json_type: The data type as represented in JSON. data_type: The Zoho CRM data type of the field.

deal_meta: Meta {     Modules(filter: { api_name: "Deals" }) {         _data {             id             api_name             module_name             description             singular_label             plural_label             fields(filter: { api_names: ["Expected_Revenue", "Deal_Name","Stage"] }) {                 _data {                     api_name                     id                     display_label                     json_type                     data_type                 }             }         }     } }

The complete query will look this:

query {   Records {     Contacts(where: { Email: { equals: "krismarrier@noemail.com" } }) {       _data {         Email {           value         }         Full_Name {           value         }         Deals__r {           _data {             Expected_Revenue {               value             }             Deal_Name {               value             }             Stage {               value             }           }         }       }     }   }   contact_meta: Meta {     Modules(filter: { api_name: "Contacts" }) {       _data {         plural_label         id         api_name         module_name         description         singular_label         fields(filter: { api_names: ["Last_Name", "Email"] }) {           _data {             id             api_name             display_label             json_type             data_type           }         }       }     }   }   deal_meta: Meta {     Modules(filter: { api_name: "Deals" }) {       _data {         plural_label         id         api_name         module_name         description         singular_label         fields(           filter: { api_names: ["Expected_Revenue", "Deal_Name", "Stage"] }         ) {           _data {             api_name             id             display_label             json_type             data_type           }         }       }     }   } }

If you were to fetch this data using REST APIs, it will involve multiple calls to the 

• Query API
• Related Records API
• Modules meta API, and 
• Fields meta API.
  

Using the GraphQL query you can fetch the required data alone in a less round trip time. While constructing a query for your custom requirement, please note that you can query up to three levels of depth (nesting levels of a field) for Records and 7 levels of depth for Metadata. 

Constructing GraphQL query using Postman

To construct a GraphQL query in Postman to suit your requirements, type {api_domain}/crm/graphql in the URL box. Postman will automatically fetch the query schema in the schema explorer, which can be used to explore the types of queries that can be made, including what fields are available on each type, what arguments those fields accept, and what other types they return.   

Constructing a Zoho CRM GraphQL query in Postman using schema explorer

You can refer to the help documentation on GraphQL APIs for more details on GraphQL APIs. 

Update 25th Sep 2024:

GraphQL APIs are now open across all DCs including IN DC for Enterprise, Zoho One Enterprise, CRM Plus and Ultimate edition orgs. Please note that GraphQL APIs are not available for Trial Edition of these editions.

We hope you found this post useful. We will meet you next week with another interesting topic!

If you have any questions, let us know in the comment section or reach out to us directly at support@zohocrm.com.

Further Reading.                                                                                                                                

• Kaizen Series
  
• GraphQL Documentation
  

Previous Kaizen Post

• Kaizen #148 - 'trigger' in Records APIs

• Topic Participants

• Mable Mary M P

  

• Sticky Posts

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

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

• Celebrating 200 posts of Kaizen! Share your ideas for the milestone post

  Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQs

• Kaizen #193: Creating different fields in Zoho CRM through API

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

• Client Script | Update - Introducing Commands in Client Script!

  Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! Commands

• Recent Topics

• Where can I find rejected inbound mails and their reason for rejection

  Hi, I was recently made aware by a mailing list which I am subscribed to (ffmpeg-devel@ffmpeg.org) that my Zoho mail Mail account is rejecting some emails. If I look under Admin Panel > Security & Compliance > Quarantine > Incoming, the list there is

• Sync more than one Workdrive

  Hello Please I'm facing some difficulties since some days. In my company we have many zoho accounts in different organisations. And I have to find a way to sync all these Workdrives. I spend many hours to search it on zoho Workdrive but no solution. Could someone help me ? Any idea how I can achieve it ? Thanks in advance. Regards

• Zoho writer unable to merge documents to PDF with basic fonts in Hebrew or fonts from my computer

  I created several forms that will be merged into PDF files through Zoho Writer and I am unable to receive the PDF in the basic fonts of the Hebrew language or in the fonts I have on my computer. The writer exports to PDF an exchange font that looks very

• Base Currency Adjustment Reversal

  Two questions surrounding the base currency adjustments (BCA). I recently ported over from QB so I need to enter the base currency adjustments. In QB, it will calculate the BCA for you at the end of the year and then reverse it at the top of the following year. Makes sense. Does Zohobooks not do this as well? I created a BCA for Dec 31, 2016 but no reversing entry was made Jan 1, 2017. Am I supposed to manually do a reversal? I'm not even allowed to post journals directly to the 'exchange gain loss'

• Please implement UAE Central Bank FX rates

  Hello, as I understand from your knowledge base, any UAE business account created from September 15, 2018 does not have foreign exchange rates fetched automatically. This is a serious inconvenience and I am not sure why ZOHO has not looked into the ways

• Search Records returning different values than actually present

  Hey! I have this following line in my deluge script: accountSearch = zoho.crm.searchRecords("Accounts","(RS_Enroll_ID:equals:" + rsid + ")",1,200,{"cvid":864868001088693817}); info "Account search size: " + accountSearch.size(); listOfAccounts = zoho.crm.searchRecords("Accounts","(RS_Enroll_ID:equals:"

• Super Admin Access to All Courses and Spaces in Zoho Learn

  Dear Zoho Learn Team, We hope this message finds you well. We are using Zoho Learn extensively for internal and agent training. While managing our courses and spaces, we encountered a significant limitation regarding admin access and course management.

• Print checks for owner's draw

  Hi.  Can I use Zoho check printing for draws to Owner's Equity?  This may be a specific case of the missing Pay expenses via Check feature.  If it's not available, are there plans to add this feature?

• [New Release 2024] Create and embed custom capabilities across CRM with Kiosk Studio, our latest no-code tool

  [Update | New series] We've started publishing a series of posts on Kiosk Studio. It's called Kiosk Studio Sessions and you can check out the first one here! [Update | 15 Oct} Session #2 is live! This one will look at how to create a kiosk for your call

• Revenue Management: #10 Common Mistakes while Recognizing Revenue

  We are at the end of the series on Revenue Management, covering how different businesses recognise revenue. Even with clear standards like ASC 606 and IFRS 15 in practice, businesses often struggle with the nuances of revenue recognition. Especially growing

• Windows Desktop App - request to add minimization/startup options

  Support Team, Can you submit the following request to your development team? Here is what would be optimal in my opinion from UX perspective: 1) In the "Application Menu", add a menu item to Exit the app, as well as an alt-key shortcut for these menus

• integarting attachments from crm to creator

  when i tried to integrate pdf attachments from crm to creator via deluge i am getting this error {"code":2945,"description":"UPLOAD_RULE_NOT_CONFIGURED"} the code i used is attachments = zoho.crm.getRelatedRecords("Attachments","Sales_Orders",203489100020279XXX8);

• Search Option

  🚫 Current Limitation: As of now (September 2025), Zoho FSM lacks a global search functionality, which makes it difficult to quickly: Find specific Work Orders by number or keyword Search for customer records or contact info Locate assets, jobs, or service

• Mobile Chat Window - Full Screen

  Hello, The mobile chat window takes up the full screen, which is highly confusing for most customers! Using a desktop machine, I see the same happens when reducing the browser width to 800px or below. This suggests that it responsive web design, causing the switch to full screen. Can we fix this very annoying behaviour ourselves using a custom css file? If so, can you please let me know how? Thanks

• Is it possible to customize ZC Themes?

  I understand you can choose a layout and customize Brand Color, App Header, Menu, and Sub-Menu components, but can you override some of the default theme settings with CSS or a config file? For example, - Table highlight color - Listview auto filter highlight

• Is it possible to create Custom function-based Lookup field in Zoho CRM

  Is it possible to create a custom function-based lookup field in Zoho CRM? If so, how? Use case: Need to fetch users from Zoho Projects into a dropdown field in Zoho CRM.

• @mention in comments no notification

  Hi, hope someone can help. When we @mention someone in the comments in Zoho Creator, how is that user notifed as we don't get anything on email or in the app notifications. 

• Zoho unified inbox

  The new changes have definitely improved things for switching between accounts.  But zoho still desperately needs a unified inbox.  It sucks to have to enter filters and folders for each and every inbox.  This seems like such a simple thing, i wonder why Zoho hasn't done it?

• Add "Running Balance" column to Account Transaction Reports

  Hello, Currently Zoho Account Transaction Reports give you the opening balance, then lists the transactions, then provides the closing balance.  It would be great if you could add a column on the far right that shows the "Running Balance" on the account after each transaction.  There are many times when analyzing or tie-ing out transactions that this would be very helpful.  I currently have to frequently run a tape on my adding machine to get balance totals after a specific transaction on the list.

• Unified customer portal login

  As I'm a Zoho One subscriber I can provide my customers with portal access to many of the Zoho apps. However, the customer must have a separate login for each app, which may be difficult for them to manage and frustrating as all they understand is that

• WhatsApp 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.

• error : Object code : 6500

  b3 = map(); b3.put("name", "Test Project Name"); updateprojects2 = invokeurl [ url :"https://projectsapi.zoho.eu/restapi/portal/era0130/projects/169495000000928007/" type :PUT parameters: b3 connection:"in2" ]; info b3 ; info updateprojects2; ------------

• How to book GST paid in zoho books

  hi, i am a new user to Zoho books and not able to book GST paid in books, kindly suggest how i can book it in books. thanks, siddharth

• I got unknown charge from Zoho

  Good day, I need help disputing a charge I don't know from, zoho. I have ZohoMail and ZeptoMail. I purchase credits for ZeptoMail, and for ZohoMail I am not subcribed.

• Function 56: Automatically enable the option for customers to pay via bank account

  Hello everyone and welcome back to our series! One of the key features of Zoho Books is its integration with multiple payment gateways, allowing you to receive online payments for your invoices. This ensures faster payments, automates payment tracking

• Attach Files to Your Notecards and share them on the go!

  Hey everyone! We’re excited to share a feature many of you have been asking for — you can now attach files directly to your text notecards and share with ease! 🙌 This update was built with your feedback in mind, especially for those who wanted a simple

• Workdrive on Android - Gallery Photo Backups

  Hello, Is there any way of backing up the photos on my android phone directly to a specific folder on Workdrive? Assuming i have the workdrive app installed on the phone in question. Emma

• How to add a % Growth column for year-over-year comparison (2024 vs 2025)

  Hello, I am trying to build a monthly revenue comparison between 2024 and 2025 in Zoho CRM Analytics. My current setup is: Module: Deals (Affaires) Filter: Stage = Closed Won Date field: Closing Date Grouping: By Month Metrics: Sum of Amount for 2024,

• How to searchByCriteria records that are under approval?

  I need to search for both approved and pending approval records Is that possible with this method? Or I need to a different method? var priceReqID = $Page.record_id; log(priceReqID); var records = ZDK.Apps.CRM.Price_List_Item.searchByCriteria("Price_Request:equals:"

• How to add Simple Analytics to Zoho Pages?

  I have a website with Zoho Pages, how do I add Simple Analytics on it? They seem to have code they need to be embedded https://docs.simpleanalytics.com/script

• Cant seem to delete an email account

  Hello, I have researching for 4 days how to delete an email account and I am absolutely without a clue. The email account I am trying to delete is support<AT>fyshoes<dot>com. It's the first email account I made and it (is???) was associated with the super user (me). I have since changed it to adming<AT>fychoes<dot>com and I see the support email in my list but I just cant seem to get rid of it. Ultimately I want to associate that email account with another user that I want to add. This is really

• Import data into Multi-Select lookup field from CSV/Excel

  How to import data into a multi-select lookup field from the CSV/Excel Sheet? Let's say I have an Accounts multi-select lookup field in the Deals module and I want to import the Deals with Accounts field. Steps:- 1. Create/edit a multi-select lookup field

• Script that deletes a record?

  We're using WP Plugin "Integration for WooCommerce and Zoho Pro", and have created a couple of Feeds to send data to Zoho. We are trying to create Contact records, but only based upon condition. Tried to make it with small Deluge function and Workflow,

• A formula that capitalises the first letter of each word

  Hi all, is there a zoho formula that can capitalise the first letter of each word in a string? INITCAP only capitalises the first letter of the first word.

• Quotes in Commerce?

  In Zoho Ecommerce, I need to be able to generate quotes, negotiate with customers, and then generate invoices. Currently, I plan to integrate Zoho CRM to generate quotes. After negotiation and confirmation, I will push the details to Zoho Ecommerce to

• Zoho Commerce - Mobile Application

  Does Zoho Commerce have a mobile application for customers to place an order?

• Register user through Phone Number by Generating OTP

  In zoho commerce , I am developing website on online food store Inilialy the user get verification code to their email for registering there account for login. But I need to login using phone number by generating OTP automatically rather than verification

• Unable to change sales_order status form "not_invoiced" to "invoiced"

  I am automating process of creating of invoice from sales_orders by consolidated sales_orders of each customer and creating a single invoice per customer every month. I am doing this in workflow schedule custom function where i create invoice by getting

• Custom Buttons for Mass Actions

  Hello everyone, We’ve just made Custom Buttons in Zoho Recruit even more powerful! You can now create Bulk Action Buttons that let you perform actions on multiple records at once, directly from the List View. What’s new? Until now, custom buttons were

• Zoho Vault Passwords

  Is there a way to consume Zoho Vault Manager passwords using the API? Thanks in advance.

• Next Page