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.
Hi all,
Hello and welcome to another week of Kaizen!
In this post, we will be discussing Frequently Asked Questions on Zoho CRM GraphQL APIs. GraphQL is a query language that provides a more flexible and efficient way to access data and metadata within your Zoho CRM organization.
Why should I try GraphQL APIs?
Using GraphQL with Zoho CRM allows you to fetch exactly the data you need in a single request, reducing over-fetching and under-fetching. It also enables you to combine multiple operations in one request, which can improve performance and reduce network overhead.
How do I authorize GraphQL requests?
Similar to Zoho CRM REST APIs, GraphQL APIs use OAuth 2.0 for authorization.
For self-clients, you can use the self-client option in the API console to get an authorization grant code. This code can be exchanged for an access token and a refresh token. Once you receive the access token, send the token in your HTTP authorization header with the value "Zoho-oauthtoken {access_token}" for each request. Check out our Postman collection for GraphQL APIs for examples.
Are GraphQL APIs available for all Zoho CRM editions?
GraphQL APIs are available in Enterprise, Zoho One Enterprise, CRM Plus and Ultimate edition of Zoho CRM. Note that it is not available in any trial editions.
What is the difference between REST APIs and GraphQL APIs?
REST APIs let clients talk to servers using standard HTTP methods such as GET, POST, PUT, PATCH, and DELETE. Instead of fetching a fixed dataset like with REST, GraphQL APIs allows you to ask for precisely the data you want. We have covered this topic in detail in our previous Kaizen post that compares REST APIs and GraphQL APIs
Do I need to do any initial setup to start using GraphQL APIs?
To start using GraphQL APIs, you have to enable GraphQL APIs for your Zoho CRM profile through the enable GraphQL API call.
- Request URL : {api-domain}/crm/graphql/actions/enable
- Method : POST
- Scope: ZohoCRM.GraphQL.UPDATE
This API call generates the GraphQL schema. GraphQL schema defines the capabilities of a server, the data it contains and the actions that can be done on it. Note that it is sufficient to invoke this API call once for each profile.
What are the operations supported in Zoho CRM GraphQL APIs?
Currently, Zoho CRM GraphQL APIs support only query operations. Query operation is analogous to the GET method in REST APIs.
How do I configure requests for Zoho CRM’s GraphQL APIs?
- Request URL: {{api-domain}}/crm/graphql
- Method: POST
- Scope: ZohoCRM.graphql.READ and scope of the corresponding resource.
How do I write a basic query in GraphQL?
The below query can be used to fetch Last_Name in Leads module.
Request body
query { Records { Leads {_data {Last_Name {value}}} } } |
Output
{"data":{"Records":{"Leads":{"_data":[ {"Last_Name":{"value":"Kitzman"}}, {"Last_Name":{"value":"Frey"}} // ... ]}}}} |
What are the supported metadata types that can be fetched using GraphQL APIs?
Using GraphQL APIs you can fetch metadata from Modules, Users, KanbanView, UserProperties, ProfilePermissions, Profiles, Roles, and Widgets
Can I fetch metadata and data of a particular module in a single query using GraphQL APIs?
Yes, using GraphQL it is possible to fetch both metadata and data in a single query.
For example, the below query can be used to fetch Last_Name from Leads module and metadata information of the Last_Name field in the Leads module.
Request body
{ Records { Leads { _data { Last_Name { value } } } } Meta { Modules(filter: { api_name: "Leads" }) { _data { fields(filter: { api_names: "Last_Name" }) { _data { id api_name display_label json_type data_type }}}}}} |
Output
{ "data": { "Records": { "Leads": { "_data": [ { "Last_Name": { "value": "Kitzman" } }, { "Last_Name": { "value": "Frey" } } // ... ] } }, "Meta": { "Modules": { "_data": [ { "fields": { "_data": [ { "id": "6660682000000002595", "api_name": "Last_Name", "display_label": "Last Name", "json_type": "string", "data_type": "text" }]}}]}}}} |
We have covered this in detail in this Kaizen post: Using GraphQL APIs to fetch data in a consolidated way.
Are there any limits applicable for a GraphQL API query?
Yes, Zoho CRM imposes certain limits on the GraphQL API to ensure fair usage.
- Credits: A single query can consume up to a maximum of 10 credits
- Complexity: Complexity is a measure of workload a query exerts on the server based on the number of fields and depth of the query. The maximum complexity allowed for a single query is 1000.
- Depth: The nesting level of a queried field is referred to as depth. The limit for metadata is seven, and for data is three.
Refer to the official documentation on GraphQL credits.
Is it possible to retrieve selective data using GraphQL APIs?
Records
You can use the where argument to filter records from each module. Each field can support type specific operators and can be combined with Boolean logic and wildcards.
For example. to fetch Email, Last_Name, ID, Phone and Mobile of contacts where last name starts with "Ni" and mobile contains the digit 5 or phone number equals 555-678-9999
Request body
{ Records { Contacts(where: { and: [ { Last_Name: { like: "Ni%" } }, { or: [ { Phone: { equals: "555-678-9999" } }, { Mobile: { like: "%5%" } } ] } ] }) { _data { Email { value } Last_Name { value } id { value } Phone { value } Mobile { value } }}}} |
Introspecting the GraphQL schema in Postman will reveal the details of fields and supported operators for each module. Check out our previous Kaizen, where we explained this using videos.
Metadata
You can use the filter argument to filter metadata resources.
For example, the query below fetches metadata of Deals module and api_name of its layouts and fields
Request body
query { Meta { Modules(filter: { api_name: "Deals" }) { _data { id singular_label plural_label layouts { _data { id api_name } } fields { _data { api_name }}}}}} |
How do I paginate results in GraphQL?
In GraphQL, we use the offset and limit argument to paginate results.
You can use offset to fetch the next page of results by passing the value from your previous response, starting with null for the initial set. For each page, the number of records has a limit: up to 100 records for root queries or 10 for nested data.
The value to be passed in offset is obtained by querying for previous_offset and next_offset inside _info object.
Is it possible to sort records in GraphQL?
The order_by argument can be used to sort the response set after fetching records to ascending or descending order.
For example, the below query fetches the fields Deal_Name, Expected_Revenue, and Probability from Deals module in descending order of probability.
Request body
query { Records { Deals(order_by: { Probability: { order: DESC } }) { _data { Deal_Name { value } Expected_Revenue { value } Probability { value } }}}} |
When should I choose Zoho CRM GraphQL APIs over Zoho CRM REST APIs, and vice versa?
Use Zoho CRM GraphQL APIs when:
You need to fetch complex, nested data from multiple resources (e.g., accounts with linked contacts and deals) in a single request and avoid under-fetching of required data/metadata.
You need to minimize over-fetching of data/metadata by selecting only specific resources, fields of the resources, and relationships of the resources.
You need to query data and metadata together efficiently.
Use Zoho CRM REST APIs when :
You need to perform simple CRUD operations (e.g., fetch/update a single product).
Your use case involves straightforward endpoints without nested data/metadata.
You need to do add/update/delete operations.
We trust that this post addressed your doubts on GraphQL APIs. If you have any questions please let us know in the comment section or reach out to us at support@zohocrm.com.
Previous Kaizen Post : Kaizen #196 - Zoho CRM Queries - Best Practices|Kaizen Directory
Access your files securely from anywhere
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Mable Mary M P
Andres
qasim
Malik Faisal Ijaz
Thomas James
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 areKaizen #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 achievedKaizen #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
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
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)Zeptomail API error 500 internal server error
Hi Everyone, getting this eror continuously! Can anyone please guide around the same! Zeptomail API error 500 internal server error Best RegardsWaiting multiple days to buy credits, causing my website to suffer
So I own a fairly large website that gets a lot of registered users. I use transmail send activation emails, and also forgot password emails. I sent an email to zoho's presales team when I was only at 4K/10K emails sent, hoping to buy more credits beforeFollow up
Hello, I sent a message 2 days ago but I don't receive any response and I cannot find my ticket here. this is the ticket: Your ticket has been created with the ticket ID 68925465 and subject "Fwd: Fishing-alert" looking forward to seeing your response.What's new in TransMail!
Note: TransMail is now ZeptoMail. Click here to know more. Hello again, everyone! We've recently crossed the 6 months mark of TransMail's launch. In this time post our launch, we have been constantly working on updating our platform and adding new featuresJune 2021 in TransMail!
Note: TransMail is now ZeptoMail. Click here to know more. Hello again, everyone! Hope you and your loved ones are doing well. If you're doing less than fine, we truly hope that things only get better for you. We've had a few updates in the past monthTransMail has a new name—ZeptoMail!
Tried navigating to TransMail's community forum but see a different name now? That's because TransMail has a new name. TransMail is now ZeptoMail! As we’ve grown from an internal service used mainly by other Zoho products to an up-and-coming competitorJuly 2021 in ZeptoMail!
Note: TransMail is now ZeptoMail. Click here to know more. Hello again, everyone! Hope you and your loved ones are doing well. We've had a few updates in the past month in ZeptoMail—some new features and some important announcements. Take look at whatSend Email From the ZeptoMail BY API
What is Zeptomail:- Transactional email service with reliable and fast delivery How we can Create a Connection for Zeptomail in Zoho CRM Go to the Setup Click on Connection Enter Connection Details:- Generate Consumer Key & Consumer Secret Using ZohoCustomer email on Opencart 3
When I place an order, 2 emails are sent: 1) administrator 2) to the user The administrator receives a beautiful letter, but the user receives a damaged letter (see screenshot). What could be the problem?[Announcement] Insert image from URL changes in Zoho Writer
Hi Zoho Writer users! We'd like to let you know that we've changed the behavior of the Insert image from URL option in Zoho Writer for security reasons. Earlier behavior Once you inserted an image URL in a Writer document, the image would be fetched fromDynamic Signature - Record owner
Hi everyone, I’m using Zoho Writer merge templates from Zoho CRM and have two questions: Owner signature: How can I automatically insert the CRM record owner’s signature in the merged document? I’m not sure where this signature is stored or how to referenceWriter sing up problom
Zoho writer sing up prolom faceUnable to copy into a new document
Whe I create a new Writer doc and attemp to copy and past I get this message. The only way to copy into a document is I duplicate an existing document, erase the text and save it under a different name and then paste the information. Not ideal. Can you[Webinar] Live demos and user Q&A with Zoho Writer product experts
Join us on June 12, 2025 for live demos based on your use cases and real-world scenarios raised via form. This is also an opportunity to get your questions answered directly by product experts from the Zoho Writer team. Webinar agenda Live demos basedZoho Writer's built-in citation and bibliography generator
Hey researchers and writers! Do you manually format citations and bibliographies, spending hours jumping between apps and tabs? If so, then check out Zoho Writer's built-in "Citations and Bibliography" feature. Imagine you're writing a thesis on the futureSingle and group checkboxes in Zoho Writer's fillable forms
Hey Writer Fam, Are you making the most out of single and group checkboxes in fillable forms in Zoho Writer? Here is a handy tip to optimize your use of checkboxes, both single and group, and enhance your data collection process. Single checkboxes: SingleCollaborate efficiently with Zoho Writer's track changes feature
Hi Zoho Writer Community, Zoho Writer's track changes feature is a simple, built-in solution that helps you and your team work together efficiently. Instead of juggling multiple versions of a document or building up a long email chain of comments, eachZoho Writer's WordPress extensions
Hey Zoho Writer users! Say goodbye to all your WordPress content publishing woes with Zoho Writer's WordPress extensions. Publish content with all your formatting and images, republish content when you update a document, and more—from a single windowTime-saving table hacks
Hey Zoho Writer Community, Do you find yourself using a lot of tables in your documents? We're here to share some of our time-saving hacks that will help you work more efficiently, organize your data, and make your documents look neat and professional.Automating document approval and signing with Zoho Writer and Zoho Sign
Hey Zoho Writer Community! Here's another automation tip to make your processes more efficient! Question: Can I send a document for client approval first, then automatically send it for signing with Zoho Sign if they approve? Since it's the same personCustomization hacks in Zoho Writer - Part 2
Hey community, We're back with some more tricks to personalize your documents, save time, and get in the zone when you work in Writer. Check out part 1 of this post if you haven't already. Let's dive right in! Document ruler units Imagine you're creatingSimplify your tax calculations with Zoho Writer
Hello Zoho Writer Community! Tax season can be stressful, but with Zoho Writer, managing your income tax calculations becomes straightforward and efficient. Here’s an example of how you can use the tables and formulae of Zoho Writer to calculate incomeEnhance document navigation with headings and TOC
Hey Zoho Writer Community! We're back with some useful features in Zoho Writer that can simplify your document creation and navigation process. Let's dive right in! Check out our video on how to make the most of Zoho Writer's heading and table of contentsUse and download in PDF format of Zoho wirter Merge template using deluge
Hello Zoho Developers. Here is some information about Zoho Writer. Writer is not just another online word processor, it's a powerful tool for editing, collaboration, and publishing. Even with its wide range of features, Writer's pared-down user interfaceCustomization hacks in Zoho Writer - Part 3
Hello everyone, Welcome back to Part 3 of our customization tips in Zoho Writer! In this third installment, we'll be diving into some essential customization settings that can enhance your document creation experience. Sender email address in mail mergeDaytime saving timezones messing up writer pdf
Hi, I need help for something I can't figure out. I created a Form to collect data and it is set up with my current Daylight Saving Time (GMT-3). This form is used to generate a contract (pdf Writer) with dates from an event that is being held in 4 monthsIssue with locked content in Writer
Hi, I have seen the documentation which outlines how to lock specific content within a Writer document so that it can't be modified by collaborators, but I have come across an issue. When the editor locks a paragraph for example, then a collaborator can'tDeprecation of certain URL patterns for published Zoho Writer documents
Hi Zoho Writer users! We'd like to let you know that we have deprecated certain URL patterns for published and embedded documents in Zoho Writer due to security reasons. If the published or embedded documents are in any of these URL patterns, then theirUsing Mail Merge Template to Print Documents with One Subform Record's Fields per Document
Hello, We have a Mail Merge template created in Zoho Writer which is not able to perform the functionality which is currently required to automate the documentation task portion of our process. The CRM module we are primarily using is based on a "Loans"Problem with Writer and Workdrive
Hi team, I’m the super admin for our Zoho One org. WorkDrive is active, and Zoho Docs is deprecated for our org. However, Zoho Writer cannot connect to WorkDrive at all — we’ve cleared cache, tried incognito, and restarted several times. I was able toSet to Review for all
We are testing the use of Writer as part of an internal review process for statement of work documents and have found that when the document is changed from Compose to Review by one person, that is not reflected for all others who view the document. IsI’ve noticed that Zoho Sheet currently doesn’t have a feature similar to the QUERY formula in Google Sheets or Power Query in Microsoft Excel.
These tools are extremely helpful for: Filtering and extracting data using simple SQL-like queries Combining or transforming data from multiple sheets or tables Creating dynamic reports without using complex formulas Having a Query-like function in Zohostock
bom/bse : stock details or price =STOCK(C14;"price") not showing issue is #N/A! kindly resolve this problemSOME FEATURES ARE NOT IN THE ZOHO SHEET IN COMPARISION TO ZOHO SHEET
TO ZOHO sir/maam with due to respect i want to say that i am using ZOHO tool which is spreadsheet i want to say that some features are not there in zoho sheet as comparison to MS EXCEL like advance filter and other Features which should be there in ZOHOZoho sheet for desktop
Hi is zoho sheets available for desktop version for windowsTip #18: 6 Trendlines and when to use them in your spreadsheet data?
Charts are a great tool for visualizing and interpreting large chunks of data in spreadsheets. Zoho Sheet offers you 35+ chart options, along with AI-powered chart recommendations based on the data set you select. There are various chart elements thatPerform customized calculations with the new LAMBDA functions!
We released the LAMBDA function in Zoho Sheet in 2021, enabling customized calculations inside predefined functions. Now, we're extending LAMBDA's capabilities with six new functions. Each of these functions applies LAMBDA to the given input, performsTip #17: Easily share spreadsheets with non-Zoho account users
With efficient, collaboration-friendly options, Zoho Sheet is a popular choice among users. Sheet's external share links help you collaborate more effectively by sharing your spreadsheets with anyone outside your organization, including users who do notWork seamlessly with Sheet's shortcuts without affecting the browser
Navigating your worksheets and performing specific actions should be a quick and easy process. That's where keyboard shortcuts come in. Shortcut keys help you accomplish tasks more efficiently, eliminating the need to move away from the keyboard. WhatNext Page