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

• Zeptomail 136.143.188.150 blocked by SpamCop

  Hi - it looks like this IP is being blocked, resulting in hard bounces unfortunately :( "Reason: uncategorized-bounceMessage: 5.7.1 Service unavailable; Client host [136.143.188.150] blocked using bl.spamcop.net; Blocked - see https://www.spamcop.net/bl.shtml?136.143.188.150

• Apply transaction rules to multiple banks

  Is there any way to make transaction rules for one bank apply to other banks? It seems cumbersome to have to re-enter the same date for every account.

• How to bulk update records with Data Enrichment by Zia

  Hi, I want to bulk update my records with Data Enrichment by Zia. How can I do this?

• Need Guidance on SPF Flattening for Zoho Mail Configuration

  Hi everyone, I'm hoping to get some advice on optimizing my SPF record for a Zoho Mail setup. I use Zoho Mail along with several other Zoho services, and as a result, my current SPF record has grown to include multiple include mechanisms. My Cloudflare

• How do I split a large CSV file into smaller parts for import into Zoho?

  Hi everyone, I’m trying to upload a CSV file into Zoho, but the file is very large (millions of rows), and Zoho keeps giving me errors or takes forever to process. I think the file size is too big for a single import. Manually breaking the CSV into smaller

• Client Script Payload Size Bug

  var createParams = { "data": [{ "Name": "PS for PR 4050082000024714556", "Price_Request": { "id": "4050082000024714556" }, "Account": { "id": "4050082000021345001" }, "Deal": { "id": "4050082000023972001" }, "Owner": { "id": "4050082000007223004" }, "Approval_Status":

• Sync Issue Between Zoho Notebook Web App on Firefox (PC) and Android App

  Hi Zoho Notebook Community, I'm facing a sync problem with Zoho Notebook. When I use the web version on Mozilla Firefox browser on my PC, I create and save new notes, and I've synced them successfully. However, these new notes aren't showing up in my

• Messages not displayed from personal LinkedIn profile

  Hello. I connected both our company profile and my personal profile to Zoho social. I do see all messages from our company page but none from my private page. not even the profile is being added on top to to switch between company or private profile,

• lead convert between modules

  Hello, The workflow we set up to automatically transfer leads registered via Zapier into the Patients module to the Leads module started to malfunction unexpectedly on September 25, 2025, at 11:00 AM. Under normal circumstances, all fields filled in the

• Flow Task Limits - How to Monitor, Understand Consumption?

  So, I got an email last night saying that I've exhausted 70% of my tasks for this month, and encouraging me to buy more tasks. I started to dig into this, and I cannot for the life of me figure out where to find any useful information for understanding,

• Cross References Do Not Update Correctly

  I am using cross references to reference Figures and current am just using the label and number, i.e. Figure #. As seen here: When I need to update the field, I use the update field button. But it will change the cross reference to no longer only including

• Manage control over Microsoft Office 365 integrations with profile-based sync permissions

  Greetings all, Previously, all users in Zoho CRM had access to enable Microsoft integrations (Calendar, Contacts, and Tasks) in their accounts, regardless of their profile type. Users with administrator profiles can now manage profile-based permissions

• How to Track and Manage Schedule Changes in Zoho Projects

  Keeping projects on track requires meticulous planning. However, unforeseen circumstances can cause changes to schedules, leading to delays. It becomes important to capture the reason for such changes to avoid them in the future. Zoho Projects acknowledges

• Is there a notification API when a new note is addeding

  Trying to push to Cliq, or email notification when there's a new note added in module. How to implement this?

• Zoho Sheet - Desktop App or Offline

  Since Zoho Docs is now available as a desktop app and offline, when is a realistic ETA for Sheet to have the same functionality?I am surprised this was not laucned at the same time as Docs.

• Collaborate Feature doesn't work

  Hello Team. It seems that the collaborate section is broken? I can post something but it all appears in "Discussions". In there is no way how I would mark something as Draft, Approval, post or any of the other filter categories? Also if I draft a post

• Edit Permission during and after approval?

  When a record is sent for approval Can a user request for edit permission from the approver? We don't want to give edit permissions for all the records under approval Only on a case-by-case basis How can we achieve this?

• Zoho web and mobile application not workingn

  Both zoho forms web and mobile application aren't working. I have checked my network connections and they are fine.

• Introducing the revamped What's New page

  Hello everyone! We're happy to announce that Zoho Campaigns' What's New page has undergone a complete revamp. We've bid the old page adieu after a long time and have introduced a new, sleeker-looking page. Without further ado, let's dive into the main

• Prevent stripping of custom CSS when creating an email template?

  Anyone have a workaround for this? Zoho really needs to hire new designers - templates are terrible. A custom template has been created, but every time we try to use it, it strips out all the CSS from the head.  IE, we'll define the styles right in the <head> (simple example below) and everything gets stripped (initially, it saves fine, but when you browse away and come back to the template, all the custom css is removed). <style type="text/css"> .footerContent a{display:block !important;} </style>

• Bulk Moving Images into Folders in the Library

  I can't seem to select multiple images to move into a folder in order to clean up my image library and organize it. Instead, I have to move each individual image into the folder and sometimes it takes MULTIPLE tries to get it to go in there. Am I missing

• Latest updates in Zoho Meeting | Breakout rooms and End to end encryption

  Hello everyone, We’re excited to share a few updates for Zoho Meeting. Here's what we've been working on lately: Introducing Breakout Rooms for enhanced collaboration in your online meetings and End-to-end encryption to ensure that the data is encrypted

• Systematic SPF alignment issues with Zoho subdomains

  Analysis Period: August 19 - September 1, 2025 PROBLEM SUMMARY Multiple Zoho services are causing systematic SPF authentication failures in DMARC reports from major email providers (Google, Microsoft, Zoho). While emails are successfully delivered due

• Accidentally deleted a meeting recording -- can it be recovered?

  Hi, I accidentally deleted the recording for a meeting I had today. Is there a way I can recover it?

• To Zoho customers and partners: how do you use Linked Workspaces?

  Hello, I'm exploring how we can set up and use Linked Workspaces and would like to hear from customers and partners about your use cases and experience with them. I have a Zoho ticket open, because my workspace creation fails. In the meantime, how is

• How to access email templates using Desk API?

  Trying to send an email to the customer associated to the ticket for an after hours notification and can't find the API endpoint to grab the email template. Found an example stating it should be: "https://desk.zoho.com/api/v1/emailtemplates/" + templateID;

• How to render either thumbnail_url or preview_url or preview_data_url

  I get 401 Unauthorised when using these urls in the <img> tag src attribute. Guide me on how to use them!

• Update Portal User Name using Deluge?

  Hey everyone. I have a basic intake form that gathers some general information. Our team then has a consultation with the person. If the person wants to move forward, the team pushes a CRM button that adds the user to a creator portal. That process is

• Zoho Bookings No Sync with Outlook

  Zoho Bookings appointments are showing on my Outlook Calendar but Outlook events are not showing on Zoho Bookings. How do I fix this?

• Unable to retrieve Contact_Name field contents using Web API in javascript function

  Hello, I've added a field in the Purchase Order form to select and associate a Sales Order (Orden_de_venta, lookup field). I've also created a client script to complete some fields from the Sales Order (and the Quote), when the user specifies the related

• Updating Woocommerce Variation Products Prices Via Zoho CRM

  I can update product prices with this flow: But I can't update variant products. I got a code from Zoho for this, but I couldn't get it to work. It needs to find the product in the CRM from the SKU field and update the variation with the price there.

• Emails Disappearing From Inbox

  I am experiencing the unnerving problem of having some of the messages in my inbox just disappear.  It seems to happen to messages that have been in there for longer than a certain amount of time (not sure how long exactly). They are usually messages that I have flagged and know I need to act on, but have not gotten around to doing so yet.  I leave them in my inbox so I will see them and be reminded that I still need to do something about them, but at least twice now I have opened my inbox and found

• Power of Automation :: Automatic removal of project users once the project status is changed.

  A custom function is a software code that can be used to automate a process and this allows you to automate a notification, call a webhook, or perform logic immediately after a workflow rule is triggered. This feature helps to automate complex tasks and

• Customizing Form Questions per Recipient Group in Zoho Campaigns/Forms

  Hello everyone, I would like to ask if it’s possible in Zoho Campaigns or Zoho Forms to send out a campaign where the form questions can be customized based on the group of recipients. Use case example: I have prepared 20 questionnaire questions. For

• Automatic category assignment

  Hi, I’d like to ask if there is a way to automatically assign an expense category based on the recognized Merchant. What would be the simplest way to set up automatic category assignment? Alternatively, is there an option to first choose the category

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

• Every time an event is updated, all participants receive an update email. How can I deactivate this?

  Every time an event is updated in Zoho CRM (e.g. change description, link to Lead) every participant of this meeting gets an update email. Another customer noticed this problem years ago in the Japanese community: https://help.zoho.com/portal/ja/community/topic/any-time-an-event-is-updated-on-zohocrm-calendar-it-sends-multiple-invites-to-the-participants-how-do-i-stop-that-from-happening

• Having Trouble Opening The Candidate Portal

  Recently am having trouble opening the Candidate Portal. It keeps loading but cannot display any widgets. Tried Safari, Chrome and Edge. Non of them work. Please solve the problem ASAP.

• Forms - Notification When Response Submitted

  How do I set it up to generate an email notification when a response (class request) is submitted?

• How to disable user entry on Answer Bot in Zobot

  Hi, I have an Answer Bot in my Zobot, here is the configuration: I only want the user to choose 1 of the 4 the options I have provided: When no answer found, user chooses 'I'll rephrase the question' or 'Ask a different question When answer is found,

• Next Page