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 #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 FAQsKaizen #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
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
Disposable Email Addresses
Dear zMail Team, Can you also bring out a few disposable email addresses for each accounts? That way occasional registrations and imminent spam from them can be largely solved right? ---- Deepak Vasudevan http://thamizhththendral.blogspot.com/Zoho sheet - Zoho expense
I want to schedule to create an expense using Zoho Sheet and flow. That is the EMI that I pay on a particular date to the bank and should be itemised, like principal and interest on the loan. Can someone help me in this regard??Ability to configure a schedule/shift for each user and/or crew in Zoho FSM
Hello, In our team of Field Agents, we have different shifts. Some field agent always work from 7:00 AM to 4:00 PM while others work the evening shift like 4:00 PM to 11:00 PM. Sometime shift are on weekdays only or on weekend. It would be great to beFree webinar: Streamlining customer service paperwork with the Zoho Sign extension for Zoho Desk
Hello Everyone! Have you been wondering about bridging the gap between digitised customer service and business paperwork? Join our free webinar to learn how you can do this by connecting Zoho Sign, our digital signature app, with Zoho Desk, our onlineZoho Books | Product updates | July 2025
Hello users, We’ve rolled out new features and enhancements in Zoho Books. From plan-based trials to the option to mark PDF templates as inactive, explore the updates designed to enhance your bookkeeping experience. Introducing Plan Based Trials in ZohoMail Search should allow grouping by conversation like Gmail.
Having switched from gmail I have found the search function hard to use. Mostly because mail is not grouped by conversation in search. If I search for a word when looking for a conversation had with someone then sometimes 10 emails will come up from theImprove Zoho Learn updated article notifications
I noticed today while updating an article, that the notification users get says "[User Name] has published article [Article Name]..." My feedback to the product team is that it would be really helpful for an end user, if the system notification differentiatedSafari Support
Safari, the world's second largest browser, zoho desk does not officially or fully support. That needs to change.Can I get images from an "Image Upload" field in a webhook?
I want to send images from 2 "image upload" fields via a webhook. Is this possible?Ticket closure notification - all contacts cc'd on email thread
Hello, If a client sends an email to our service desk and cc's in other people that work at the same company - so that they are in the loop of the service request. When the we close the ticket, only the ticket owner (person who emailed us - which createdInactive account cleanup policy for Zoho Sign
Zoho Sign reserves the right to delete accounts that are license free and inactive for more than 120 days. The account deletion will be initiated only after the user receives prior email notice about possible data deletion and how to backup the data.Missde API documentation for Sales Receipt
Hi! I noticed that the Sales Receipt endpoint is not currently listed in your API documentation (https://www.zoho.com/books/api/v3/introduction/). Could you please provide any available temporary documentation for this endpoint, along with a detailedMulti-currency in Zoho CRM Forecast and Reports
As a company we have branches in 4 different countries with as many different currencies. Our Sales Teams would like to work with their local currency as much as possible. The Forecast module using only 1 currency is practically usable only by the salesHow to select from pricebook when creating a salesorder or quote
I am creating a sales order and when selecting the Products I do not see any where to select from pricebooks. How do i associate this to my orders?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 providesI cannot find my older documents from 2024 and 2023
I cannot find my older documents from 2024 and 2023.System default SLA descriptions can't be modified
The system default SLAs have identical descriptions for all SLA levels, but their settings differ. However, I am facing an issue where I cannot modify these descriptions and save the changes. The content of the description box can be edited but the changesCustomising Help Center
Hi I don't think it is possible to add custom pages to help center? We'd like to use this as a customer portal with support tickets, FAQ/Guides, Billing and contracts. Is there any plans to add a feature like this or an alternative way to do it otherReplies sometimes creating separate ticket
Sometimes when a customer responds to an email coming from Zoho Desk, instead of adding a reply to the original ticket, a separate ticket is created. This happens even though the response subject line contained the ticket number, and the person respondingTicket Approvals - External Users
The ticket approval option - we need to be able to select external users (Contacts) for approvals. Sometimes we are working with an end user and their boss needs to approve a purchase. For example, working with a cashier on a broken cash register andForce Users to Ask Answer Bot a question... First
End users will always skip talking to a bot. It would be nice if Zoho adopted the standard and forced users to first ask a question to answer bot (or zia in some fashion) and then pass to the agent if it wasn't answered. Options to force the user to speakView Answer Bot conversations?
We are trialing Zia and are experimenting with Answer Bot on our knowledge base. So far so good! Management asks me if it is possible to view Answer Bot conversations, the purpose being to look over its shoulder and confirm that it is working as desMass Email an Account
It would be nice to mass email an account stating there is an outage at their business or something specific to an account is needed to be mass communicated. Even if it makes a ticket for every Email Out to every contact in the Account. Think: the customerMultiple Topics assigned to a single Campaign
Hello, is it possible to assign multiple Topics to a single Campaign? We frequently write a content to our subscribers that spans multiple Topics and we would like to send it to all Contacts that are subscribed to at least one of the Topics. But it looksZoho Projects Fonts and Accessibility missing
I cannot find any more the tab where I can change the font in Zoho Project. I also checked the knowledgebase and there they have accessibility tab which I am completely missing. Is there some setup I am missing or is it a problem with our account?Zoho Books Custom Widgets Deprecation Error
I created a simple sample widget with zet and published it using sigma Both in the Sandbox and Production the Widgets are showing this errorProblems with PDF files in notebook
I'm evaluating Zoho Notebook as an alternative to Evernote and imported my Evernote account to Zoho Notebook. First issue is that notes in Evernote that comprise a PDF are turned into a 'group' with a single note page (that has the text from the EvernoteAPI (v3) Tasks sorting issue
We are using the v3 API for Projects. When we gat all tasks, per page of 100 tasks, we get the task info alright. But when we try to sort based on DESC(last_modified_time) we don't get the correct sort order. It is roughly sorted by the last_modified_time,Assemblies make my stock go negative
I am sure this is just the way that we are using this feature, but we use assemblies, a lot. The issue for us is the way that the relive inventory and the fact that it makes our composite item stock go negative. I have added flows to auto assemble andUser Activity Reports
I'd like to get data related to user activity. For example, Login and logout times, emails sent/received, new records created , etc. Is that currently available. I just can't seem to find anything . Thanks, DaveHelp: Populate “Contact Owner” details into Customer custom fields (for email templates) in Zoho Books
We want to send invoices on behalf of our sales agents, and include the agent’s name, email, and phone in the email body using placeholders. Plan is to copy the Customer Owner details into three Customer custom fields, so they can be used as placeholdersUndocumented Books API error message - 1000 - The requested action could not be completed. Please try again. | Unexpected error
This code sometimes throws this error 1000 - The requested action could not be completed. Please try again. | Unexpected error What does it mean? result = zoho.books.updateRecord("salesorders",organization.get("organization_id"),salesorder_id,sales_Partial payments for retainer invoices
When a customer does not pay the entire retainer invoice there is no way to apply a partial payment. PLEASE add this function.Making Tags Mandatory
When creating an expense, is it possible to make the Tags field mandatory? I see the option in settings to make other fields mandatory, like Merchant, Description, Customer, etc, but nothing about Tags. Thanks! KevinMass Update not trigger workflows
Hi, I have performed a mass update of all records in a custom module using a custom view. I have a dummy checkbox on my module that I turn on or off - hoping to trigger all the new workflows that have been created for that module. However, no workflowsMulti-Select lookup field has reached its maximum??
Hi there, I want to create a multi-select lookup field in a module but I can't select the model I want the relationship to be with from the list. From the help page on this I see that you can only create a max of 2 relationships per module? Is that true?Generating CRM reports based on date moved in staged history
Hi everyone, I'm trying to generate CRM reports of jobs (I think these are called usually deals) based on when they were moved to a particular stage, ie all jobs that were moved to Proposal/Quote in the previous financial year. I can see from other similarModules for missed calls, emails, texts etc
Hi there. Is there a way to create a module that would automatically show a list of all inbound calls that were missed by our users, as well as any inbound SMS's, emails & WhatsApp messages. That way, a user who is available, can work through that listSubforms and automation
If a user updates a field how do we create an automation etc. We have a field for returned parts and i want to get an email when that field is ticked. How please as Zoho tells me no automation on subforms. The Reason- Why having waited for ever for FSMConditional layouts - support for multi-select picklists
Hi, The documentation for conditional layouts says the following: "Layout Rules cannot be used on the following field types: Auto Number Lookup Multi Select Lookup User Lookup Formula File Upload Multi Line" I have a custom module with a multi-pick listNext Page