Introducing Zoho CRM GraphQL APIs: Our Next Frontier!

Introducing Zoho CRM GraphQL APIs: Our Next Frontier!

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.

Update 27th Aug 2024:
Opening up GraphQL APIs for more editions
We are delighted to inform you that GraphQL APIs are currently available across all DCs except IN DC for Enterprise, Zoho One Enterprise and CRM Plus edition orgs. Please note that GraphQL APIs are not available for Trial Edition of these editions. We estimate that GraphQL APIs will be open in IN DC within one month. If your org is in IN DC and you are eager to try out GraphQL APIs,  you can register for early access here: GraphQL Early Access Registration.

Update 26th Apr 2024:
Early access available for Enterprise, Zoho One Enterprise and CRM Plus editions.
To register for early access, please fill in this form: GraphQL Early Access Registration.
Hello Developers,

We are excited to announce the release of Zoho CRM GraphQL APIs as a part of Zoho CRM - Q1 2024 update!
Our GraphQL APIs are now available to all Zoho CRM Ultimate paid orgs across all DCs. You can refer to the help documentation on GraphQL APIs for details on everything GraphQL .

What are GraphQL APIs?

Let us use a sandwich shop analogy to explain the concept of GraphQL.
Imagine you're at a sandwich shop - Cafe Rest Stop. The menu is extensive, offering various sandwiches with different ingredients. You want a tuna sandwich, and you're not a fan of pickles. You ask the chef for a sandwich without pickles. However, you are informed that the pickles are already prepped and placed on the sandwiches, and they can not be removed. You're faced with a dilemma: either accept the tuna sandwich with pickles or choose a different sandwich altogether.
This scenario mirrors the traditional REST endpoint model. When you make a request to a REST API endpoint, you receive a predefined set of data in response, much like ordering a sandwich with fixed ingredients. If you need something slightly different, like excluding certain data fields or including additional ones, you're often out of luck unless the API specifically offers those customization options.

Now, let's imagine another sandwich shop - Cafe Graffiti.  Here, instead of ordering predefined sandwiches, you have the freedom to customize your sandwich exactly the way you want it. You start with a base sandwich, like tuna, and then you can specify your preferences for each ingredient. You can say "no pickles," "extra lettuce," or "add avocado," and the chef will tailor your sandwich accordingly.
This is analogous to GraphQL. With GraphQL, you have a single endpoint through which you can request exactly the data you need, no more and no less.  You specify the fields you want to retrieve, and you get back precisely that data in the format you requested. 
Excited to tap into the potential of Zoho CRM GraphQL APIs? Refer to the 'Getting Started' page in the help documentation, accessible through this link.

Here is how it works:

Our GraphQL APIs offer a comprehensive solution for accessing both data and metadata within your Zoho CRM org.  From retrieving metadata across various resources like modules, Users, KanbanView, Profiles and so on,  to supporting advanced querying capabilities that streamline the retrieval of records in different modules, our GraphQL APIs offer unparalleled flexibility. GraphQL empowers you to precisely request resources, it's field, and the relationships between different resources.
But that is not all. Zoho CRM GraphQL APIs allows  you to aggregate data from multiple dependent or independent entities in a single API call. Whether you're looking to minimize network round trips or ensure optimal bandwidth utilization, our GraphQL APIs have you covered.

Here's an example of a GraphQL query that fetches records of Accounts containing "Truhlar" in their name along with their associated contacts and owner details. It also retrieves metadata about the "Accounts" module, including information about relevant fields like "Account_Name," "Owner," and "Parent_Account.


{
    Records {
        Accounts(where: { Account_Name: { like: "%Truhlar%" } }) {
            _data {
                id {
                    value
                }
                Account_Name {
                    value
                }
                Parent_Account {
                    id {
                        value
                    }
                    Account_Name {
                        value
                    }
                }
                Contacts__r {
                    _data {
                        id {
                            value
                        }
                        Full_Name {
                            value
                        }
                        Email {
                            value
                        }
                        Owner {
                            id {
                                value
                            }
                            first_name {
                                value
                            }
                            email {
                                value
                            }
                            last_name {
                                value
                            }
                            zuid {
                                value
                            }
                        }
                    }
                }
                Owner {
                    id {
                        value
                    }
                    email {
                        value
                    }
                    zuid {
                        value
                    }
                    last_name {
                        value
                    }
                    first_name {
                        value
                    }
                }
            }
        }
    }
    Meta {
        Modules(filter: { api_name: "Accounts" }) {
            _data {
                id
                api_name
                module_name
                visibility
                fields(filter: { api_names: ["Account_Name", "Owner", "Parent_Account"] }) {
                    _data {
                        id
                        api_name
                        display_label
                        data_type
                    }
                }
            }
        }
    }
}


Similar to our Rest APIs, Zoho CRM GraphQL API calls are also associated with credits. Each API call may consume up to 10 credits, with additional credits required for specific resource types. In addition to that, we have query complexity based on the workload a query exerts on CRM servers and depth. Please refer to the Credits, Complexity, and Depth page on our help document for details.
We hope you are excited to try out Zoho CRM GraphQL APIs. As always, your suggestions and requests are most welcome. We will work on fulfilling them as promptly as we can.


Thank you,

Zoho CRM API Team



    Access your files securely from anywhere







                            Zoho Developer Community




                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                  • Ask the Experts



                                                            • Sticky Posts

                                                            • Kaizen #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
                                                            • Kaizen #152 - Client Script Support for the new Canvas Record Forms

                                                              Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achieved
                                                            • Kaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script

                                                              Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.
                                                            • Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI

                                                              Hello Everyone, Welcome back to yet another post in the Kaizen Series! As you already may know, for the Kaizen #200 milestone, we asked for your feedback and many of you suggested topics for us to discuss. We have been writing on these topics over the


                                                            Manage your brands on social media



                                                                  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

                                                                                      • CRM Community Learning Series

                                                                                        CRM Community Learning Series


                                                                                      • Kaizen

                                                                                        Kaizen

                                                                                      • Functions

                                                                                        Functions

                                                                                      • Meetups

                                                                                        Meetups

                                                                                      • Kbase

                                                                                        Kbase

                                                                                      • Resources

                                                                                        Resources

                                                                                      • Digest

                                                                                        Digest

                                                                                      • CRM Marketplace

                                                                                        CRM Marketplace

                                                                                      • MVP Corner

                                                                                        MVP Corner







                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now


                                                                                            Zoho Show Resources

                                                                                              Zoho Writer

                                                                                              Get Started. Write Away!

                                                                                              Writer is a powerful online word processor, designed for collaborative work.

                                                                                                Zoho CRM コンテンツ



                                                                                                  Nederlandse Hulpbronnen


                                                                                                      ご検討中の方




                                                                                                              • Recent Topics

                                                                                                              • How to setup DKIM / SPF in Zoho Mail

                                                                                                                Hello there! I'm having a hard time understanding how to setup the TXT records for SPF and DKIM with Zoho Mail. I'm following the instructions here: https://www.zoho.com/campaigns/help/setup-spf-dkim.html Specifically, when it comes to the value for the
                                                                                                              • Mass update cant trigger a workflow?

                                                                                                                Hello there, Is this a normal Creator behaviour? In a report, if I manually edit each data row, it will pass those changes to all other reports. However, if I perform a Mass Update on a few data rows at once, the new data is not pushed to other reports.
                                                                                                              • Exciting Updates to the Kiosk Studio Feature in Zoho CRM!

                                                                                                                Hello Everyone, We are here again with a series of new enhancements to Kiosk Studio, designed to elevate your experience and bring even greater efficiency to your business processes. These updates build upon our ongoing commitment to making Kiosk a powerful
                                                                                                              • search and Smart Bar both missing in Mail

                                                                                                                One of the users on my account does not have the search bar at the top right or the Smart Bar at the bottom left of the desktop Mail app. Any ideas how to get those back?
                                                                                                              • "Wrong password or login" Problem to configure Zoho on MAIL App on my Macbook

                                                                                                                Hi, I'm having problems to configure my e-mail on my MAIL App(Macbook pro). My e-mail is hari@trespontoum.net Actually was working perfectly, and still working on my Iphone. My MAIL App prompt me that my login or password is wrong. I tried to change 3
                                                                                                              • Remote Control Functionality During Screen Sharing in Zoho Cliq

                                                                                                                Hello Zoho Cliq Team, We would like to request the addition of remote control functionality during screen sharing sessions in Zoho Cliq. Currently, while screen sharing in Cliq is very useful, it lacks the ability for another participant to take control
                                                                                                              • Looking for best practices to import data from SAP Business One (on-prem) into Zoho Analytics via Zoho DataPrep / Databridge — daily automated schedule

                                                                                                                Hi all, I’m using SAP Business One on-prem (SQL Server / or HANA — depending on DB backend) as our ERP. I want to build a pipeline that, every morning at 9:00 AM IST: pulls transactional data (invoices, customers, products, stock, etc.) from SAP B1, loads
                                                                                                              • Let us add Lookup fields in the Blueprint Transitions

                                                                                                                We are unable to add Lookup Fields in the blueprint transitions in Zoho Desk, we wanted to make it a requirement for our workflow but since it's not available in the transition we cannot. The lookup field exists in the Layout: But it cannot be added/selected
                                                                                                              • Zoho Projects API Scope for Issue Attachments

                                                                                                                I try to download issue attachments via the API, unfortunately I always get the following error code when trying to download the file from the supplied URL: {"ERROR_MESSAGE":"INVALID_OAUTHSCOPE","ERROR_CODE":401} indicating an auth scope error. I've tried
                                                                                                              • How to fetch custom fields for time entries in Zoho Project API v3

                                                                                                                In the previous Zoho Projects REST API, we were able to retrieve custom field details for time entries, including picklist options, using the endpoint: GET /restapi/portal/[PORTAL_ID]/timesheetcustomfields In the new Zoho Projects API v3, we tried using
                                                                                                              • Zoho Survey Enhancements

                                                                                                                We love Survey. We use it a ton. It needs some enhancements. Maybe some of these are already on the roadmap? API - this is crucial. We have some complex surveys that take place and need to update records, trigger other functions/automations, etc. I would
                                                                                                              • Images Don't Display on Blog

                                                                                                                Hi, I've just posted a new blog entry, but regardless of format (png or jpeg) Images that display in Preview mode do not display on any browser in the published post.  I've not done anything different with this post than others regarding images, please advice. Thanks! Edit:  I've discovered that moving the image files from a my sub directory folder "Pics for Blog" to the top level of the "Files" folder on my site allows the images to display live.  This, even though my other blog posts are correctly
                                                                                                              • Creating multiple CRM leads from a Zoho Forms subform

                                                                                                                Hi all, We have a heavily used intake form that is used for new leads as a part of our intake. There is a subform that allows the lead to add additional team members, their titles and other basic info. That form submission creates a new Lead and the subform
                                                                                                              • Checkbox Field Mapping Zoho Forms to Zoho Sign

                                                                                                                I have an application that will be filled out via Forms that I am mapping into a PDF Filler on Zoho Sign. I need to have a series of checkboxes mapped to the corresponding fields in Sign and I only see single checkboxes available via the mapping, though
                                                                                                              • MCP > Creator connection failing with Claude

                                                                                                                I'm trying to get claude to access any of my Zoho Creator apps and it keeps failing. I have enabled all tools for creator and ensured in claude settings that everything is authorised. Here is what claude says : Unfortunately, the error messages I'm receiving
                                                                                                              • Books P&L by Customer

                                                                                                                Lately, we have found that the Customer field filter for the Profit & Loss report in Zoho Books is no longer available. We have several projects with the same customer and look at the P&Ls by project AND by Customer (overall). Can you please add back in this field selection alongside the Project field to the P&L report filter? Thanks! -Gina
                                                                                                              • Sent mail sort by date disappeared

                                                                                                                Hello, We used to be able to sort the emails by date in the sent folder, but this feature has recently disappeared. Can we bring it back?
                                                                                                              • I cannot check out to Zoho People.

                                                                                                                When I tried to check out today, there's prompt that inhibits me to check out: To add entry in Attendance, log time for any of your jobs
                                                                                                              • Pricing Strategies: #2 Plan your Service Offerings using Plans

                                                                                                                Meet Harvey & Mia, hailing from the same Tech school, carrying the dream of setting up their own IT maintenance firm in their location. They drew up a clear business plan and put their business in motion on New Year's Eve. They had great reception right
                                                                                                              • Open a record to edit based on another form being edited

                                                                                                                Hi all, I am trying to edit a record based on another record being edited. It works out like this: When I create a Monthly_Update and then submit I open the Monthly_Levels form and pass the ID from the Monthly_Update to a field called mu. I want it to
                                                                                                              • Problem with signature on zoho survey

                                                                                                                Hello, I'm trying to export individual responses with signatures on zoho survey. But the signatures on some of my surveys are not exported as the original image, but as a generic image, same for all (screen joins). Is there a solution to have the signatures
                                                                                                              • Change in Zoho CRM API?

                                                                                                                Hello, I am using the Zoho API trough the PHP SDK v2.1 Since few days, I noticed that I have to change the way I pass the data to the API when I create, update, or upsert a record. Dates Before I was passing a PHP date object to "$record->addKeyValue(...)",
                                                                                                              • MTA - BAD IP reputation by outlook/hotmail

                                                                                                                Messages to Microsoft email servers are bouncing back due to poor reputation. Message: 4.7.650 The mail server [136.143.188.206] has been temporarily rate limited due to IP reputation. For e-mail delivery information see https://postmaster.live.com (S775)
                                                                                                              • QuickBooks Extension for Zoho CRM - Advanced Features -2025

                                                                                                                Hello Everyone, We’re happy to announce the latest version of our QuickBooks Extension for Zoho CRM, now officially live on the Zoho Marketplace! This release introduces one-click data sync, a user-friendly UI, enhanced performance, and a powerful set
                                                                                                              • Changing Department often causes the Firefox tab to freeze

                                                                                                                Title, it doesn't seem to happen with neither Opera nor Chrome. And even in Firefox, sometimes it just lets me change the department I'm in no problem, even to All Departments which is probably the most, like, resource heavy? But most of the time, the
                                                                                                              • Need to integrate Zoho Mail Mobile app with Zoho Meeting Mobile App for Android and Apple

                                                                                                                Hello Zoho Team, Please bring integration of Zoho Mail Mobile app with Zoho Meeting for Android and Apple Thanks
                                                                                                              • ¡Muchas gracias por participar a los Meetups de Usuarios de Zoho! Y Novedades del ecosistema Zoho

                                                                                                                ¡Hola Comunidad de Zoho en Español! 👋 Después de un breve lapso de tiempo, volvemos con una nueva edición de nuestro Community Digest, donde te contamos las novedades de los productos de Zoho en los últimos meses. Estas mejoras se centran en nuestros
                                                                                                              • Anyway to move mail from one account to another yet?

                                                                                                                Hello, Is there any way to move email from one mailbox account to another mailbox account in zoho yet? Thanks, Ryan.
                                                                                                              • Using a CRM Client Script Button to create a Books Invoice

                                                                                                                Hello, I need help handling error messages returned to my client script from a function. The scenario I have setup a client script button which is available from each Deal. This CS executes a crm function, which in turn creates an invoice based on the
                                                                                                              • Building Toppings #2 - Learn how to use Bigin's Developer Console to build toppings

                                                                                                                Hey Biginners, In our last post, we discussed what toppings are, why they're essential to extending Bigin's capabilities, and how the Bigin Developer Center serves as the starting point for building them. As a cloud platform, the Developer Center empowers
                                                                                                              • Proposal for Creating a Unique "Address" Entity in Zoho FSM

                                                                                                                The "Address" entity is one of the most critical components for a service-oriented company. While homeowners may change and servicing companies may vary, the address itself remains constant. This constancy is essential for subsequent services, as it provides
                                                                                                              • Links are incorrect when sent out

                                                                                                                I'm adding in hyperlinks into my eDM. When I send a test email, it's all correct. However, when I send out the eDM, all the hyperlinks jump up one space so none of the links are opening to the correct page. Why is this happening and how can I fix it?
                                                                                                              • Tip of the week #16 - Search and filter threads based on criteria

                                                                                                                Zoho TeamInbox lets you search and filter threads with any information that you have about the thread. You just have to input the criteria and Zoho TeamInbox will list all the threads that match the condition.   Firstly, there is a global search you can
                                                                                                              • Introducing recipient authentication via Stripe Identity in Zoho Sign

                                                                                                                Hi everyone! It's important to authenticate your recipient's identity before they access and sign important documents to ensure the highest level of compliance. Zoho Sign already helps businesses do this with various authentication methods: SMS OTP Email
                                                                                                              • Introducing Multi-Asset Support in Work Orders, Estimates, and Service Appointments

                                                                                                                We’re excited to announce a highly requested enhancement in Zoho FSM — you can now associate multiple assets with Work Orders, Estimates, and Service Appointments. This update brings more clarity, flexibility, and control to your field service operations,
                                                                                                              • CRM: hosting a single html file in Zoho and displaying it as a widget

                                                                                                                I have seen that CRM offers the option of uploading a web project to Zoho itself and displaying it as a widget in CRM. The instructions then talk about setting a development environment with Node and developing an application to upload to Zoho. But I
                                                                                                              • Keep Converted Leads

                                                                                                                How do I keep the converted leads in the Leads Module after conversion (converting it to account, contact, deal). I want to add it in a converted stage in the leads module in order to get a report or dashboard and see all converted leads from my pip
                                                                                                              • Customizing Global Search Settings for All Users

                                                                                                                Hi Our team use the brilliant global search functionality within CRM many many times daily. But, we struggle with the out-of-the box columns that CRM gives you. We are always telling users to customize this look to more suit our business, to show the
                                                                                                              • Introducing Formula Fields for performing dynamic calculations

                                                                                                                Greetings, With the Formula Field, you can generate numerical calculations using provided functions and available fields, enabling you to derive dynamic data. You can utilize mathematical formulas to populate results based on the provided inputs. This
                                                                                                              • From Zoho CRM to Paper : Design & Print Data Directly using Canvas Print View

                                                                                                                Hello Everyone, We are excited to announce a new addition to your Canvas in Zoho CRM - Print View. Canvas print view helps you transform your custom CRM layouts into print-ready documents, so you can bring your digital data to the physical world with
                                                                                                              • Next Page