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

• BUTTONS SHOWN AS AN ICON ON A REPORT

  Hi Is there any way to create an action button but show it as an icon on a report please? As per the attached example? So if the user clicks the icon, it triggers an action?

• Dropshipping Address - Does Not Show on Invoice Correctly

  When a dropshipping address is used for a customer, the correct ship-to address does not seem to show on the Invoice. It shows correctly on the Sales Order, Shipment Order, and Package, just not the Invoice. This is a problem, because the company being

• RFQ MODEL

  A Request for quotation model is used for Purchase Inquiries to multiple vendors. The Item is Created and then selected to send it to various vendors , once the Prices are received , a comparative chart is made for the user. this will help Zoho books

• Will zoho thrive be integrated with Zoho Books?

  title

• Product Updates in Zoho Workplace applications | August 2025

  Hello Workplace Community, Let’s take a look at the new features and enhancements that went live across all Workplace applications this August. Zoho Mail Delegate Email Alias Now you can let other users send emails on your behalf—not just from your primary

• Notebook audio recordings disappearing

  I have recently been experiencing issues where some of my attached audio recordings are disappearing. I am referring specifically to ones made within a Note card in Notebook on mobile, made by pressing the "+" button and choosing "Record audio" (or similar),

• Unable to send message; Reason:554 5.1.8 Email Outgoing Blocked

  Hi, I sent few emails and got this: Unable to send message; Reason:554 5.1.8 Email Outgoing Blocked And now I have few days since I cant send any email. Is there something wrong I did? Also can someone fix this please

• Want to use Zoho Books in Switzerland. CHF support planned?

  Hi, We're a Swiss company using other Zoho suite software and I discovered Zoho Books and other accounting SaaS when looking for an accounting tool. Do you intend to cover Switzerland and CHF based accounting anytime soon? Roy

• Zoho sheet desktop version

  Hi Zoho team Where can I access desktop version of zoho sheets? It is important as web version is slow and requires one to be online all the time to do even basic work. If it is available, please guide me to the same.

• Weekly Tips : Teamwork made easy with Multiple Assignees

  Let's say you are working on a big project where different parts of a single task need attention from several people at the same time—like reviewing a proposal that requires input from sales, legal, and finance teams. Instead of sending separate reminders

• Best way to share/download presentation files in Zoho without losing formatting?

  Hello Zoho Community, I often work with PPT/PDF files in Zoho Docs and share them with colleagues. While PDFs usually give a direct download option, I’ve noticed that PPT/PPTX files sometimes only open in the viewer without a clear download link. Is there

• Celebrating Connections with Zoho Desk

  September 27 is a special day marking two great occasions: World Tourism Day and Google’s birthday. What do these two events have in common (besides the date)? It's something that Zoho Desk celebrates, too: making connections. The connect through tourism

• What is Resolution Time in Business Hours

  HI, What is the formula used to find the total time spent by an agent on a particular ticket? How is Resolution Time in Business Hours calculated in Zohodesk? As we need to find out the time spent on the ticket's solution by an agent we seek your assistance

• How use

  Good morning sir I tried Zoho Mail

• Adding Overlays to Live Stream

  Hello folks, The company I work for will host an online event through Zoho Webinar. I want to add an overlay (an image) at the bottom of the screen with all the sponsors' logos. Is it possible to add an image as an overlay during the live stream? If so,

• Email Sending Failed - SMTP Error: data not accepted. - WHMCS Not sending emails due to this error

  I have been trying to figure out a fix for about a week now and I haven't found one on my own so I am going to ask for help on here.  After checking all the settings and even resetting my password for the email used for WHMCS it still says: Email Sending Failed - SMTP Error: data not accepted.  I have no clue how to fix it at this point. Any insight would be lovely. 

• Does Zoho Learn integrate with Zoho Connect,People,Workdrive,Project,Desk?

  Can we propose Zoho LEarn as a centralised Knowledge Portal tool that can get synched with the other Zoho products and serve as a central Knowledge repository?

• Zoho Flow - Update record in Trackvia

  Hello, I have a Flow that executes correctly but I only want it to execute once when a particular field on a record is updated in TrackVia. I have the trigger filters setup correctly and I want to add an "update record" action at the end of the flow to

• Add Comprehensive Accessibility Features to Zoho Desk Help Center for End Users

  Hello Zoho Desk Team, We hope you're doing well. We’d like to submit a feature request to enhance the client-facing Help Center in Zoho Desk with comprehensive accessibility features, similar to those already available on the agent interface. 🎯 Current

• Rename Record Summary PDF in SendMail task

  So I've been tasked with renaming a record summary PDF to be sent as part of a sendmail task. Normally I would offer the manual solution, a user exports the PDF and uploads it to a file upload field, however this is not acceptable to the client in this

• in zoho creator Sales Returns form has sub form Line Items return quantity when i upate the or enter any values in the sub form that want to reflect in the Sales Order form item deail sub form field Q

  in zoho creator Sales Returns form has sub form Line Items return quantity when i upate the or enter any values in the sub form that want to reflect in the Sales Order form item deail sub form field Quantity Returned\ pls check the recording fetch_salesorder

• Estimates with options and sub-totals

  Hi It seems it would be great to be able to show multiple options in an estimate. For instance I have a core product to which I can add options, and maybe sub-options... It would be great to have subtotals and isolate the core from the not compulsory items. Thanks

• Optional Items Estimate

  How do you handle optional items within an estimate? In our case we have only options to choose with. (Like your software pricing, ...standard, professional, enterprise) How can we disable the total price? Working with Qty = 0 is unprofessional....

• Important Update : Zendesk Sell announced End of Life

  Hello Zendesk users, Zendesk has officially announced that Zendesk Sell will reach its End of Life (EOL) on August 31, 2027 (Learn more). In line with this deprecation, Zoho Analytics will retire its native Zendesk Sell connector effective October 1,

• Zoho Sheets

  Hi, I am trying to transition into Zoho sheets, I have attached the issues encountered. Server issues, file trying to upload for more than 30 mins, even once uploaded my data aren't loaded. Simple calculations are not working I have attached the sample.

• Zoho CRM + Zoho FSM : alignez vos équipes commerciales et techniques

  La vente est finalisée, mais le parcours client ne fait que commencer ! Dans les entreprises orientées service, conclure une vente représente seulement la première étape. Ce qui suit — installation, réparation ou maintenance régulière — influence grandement

• Top Bar Shifting issue still not fixed yet

  I mentioned in a previous ticket that on Android, the top bar shifts up when you view collections or when you're in the settings. That issue still hasn't been fixed yet. I don't wanna have to reinstall the app as I've noticed for some reason, reinstalling

• Power of Automation:: Automate the process of updating project status based on a specific task status.

  Hello Everyone, Today, I am pleased to showcase the capabilities of a custom function that is available in our Gallery. To explore the custom functions within the Gallery, please follow the steps below. Click Setup in the top right corner > Developer

• ZOHO SHEETS

  Where can I access desktop version of zoho sheets? It is important to do basic work If it is available, please guide me to the same

• Attention API Users: Upcoming Support for Renaming System Fields

  Hello all! We are excited to announce an upcoming enhancement in Zoho CRM: support for renaming system-defined fields! Current Behavior Currently, system-defined fields returned by the GET - Fields Metadata API have display_label and field_label properties

• Billing Management: #3 Billing Unbilled Charges Periodically

  We had a smooth sail into Prorated Billing, a practice that ensures fairness when customers join, upgrade, or downgrade a service at any point during the billing cycle. But what happens when a customer requests additional limits or features during the

• No bank feeds from First National Bank South Africa since 12 September

  I do not know how Zoho Books expects its customers to run a business like this. I have contacted Zoho books numerous times about this and the say it is solved - on email NO ONE ANSWERS THE SOUTH AFRICAN HELP LINE Come on Zoho Books, you cannot expect

• Citation Problem

  I had an previous ticket (#116148702) on this subject. The basic problem is this; the "Fetch Details" feature works fine on the first attempt but fails on every subsequent attempt, Back in July after having submitted information electronically and was

• Open Sans Font in Zoho Books is not Open Sans.

  Font choice in customising PDF Templates is very limited, we cannot upload custom fonts, and to make things worse, the font names are not accurate. I selected Open Sans, and thought the system was bugging, but no, Open Sans is not Open Sans. The real

• Failing to generate Access and Refresh Token

  Hello.  I have two problems: First one when generating Access and Refresh Token I get this response:  As per the guide here : https://www.zoho.com/books/api/v3/#oauth (using server based application) I'm following all the steps. I have managed to get

• 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

• Next Page