Introducing Zoho Creator's v2 APIs

Introducing Zoho Creator's v2 APIs

Hello App Creators,

Welcome to Zoho Creator's v2 APIs! This post will serve as the central point for migrating implementations of Creator's current APIs (v1) to v2.

Improvements that v2 brings

  • OAuth-based authentication, which is more secure than the authtokens
  • Support for the PATCH and DELETE methods
  • Better structuring of the API request: form data is to be added to the request’s body in the JSON format
  • Better error handling resulting from a more insightful set of error codes and messages
  • Better performance in comparison to the current version (v1)
  • No keyword restrictions

Documentation


Other things to know

  • v2 APIs accept only JSON inputs, and return the response in the JSON format
  • The request rate is the same for v2 APIs as well — 50 requests per minute per API endpoint per IP address
  • Unlike v1, there's no limit to the response size in v2. However, v2 APIs can process a maximum of 200 records per request.
  • The Get Record - Detail View API will not fetch the records displayed in the related data blocks (if any)
  • For Creator 5 accounts, the view records API (v1) fetches data from the fields that are displayed in the quick view and detail view. The corresponding v2 APIs are view-specific: Get Record - Detail View and Get Records - Quick View.

Migration to v2

Zoho Creator’s v1 APIs will reach their end-of-life on 3rd February, 2021. Thus we recommend that you use our v2 APIs for upcoming implementations and start migrating your v1 implementations as soon as possible.

To migrate your v1 implementations to v2, in short:
  1. Revisit the reasons for which you used our v1 APIs.
  2. Identify the scopes you'll require for those operations.
  3. Register the client applications that are to use the Creator APIs, by creating client credentials for them.
  4. Generate access and refresh tokens.
  5. Set up connections from your applications to Zoho Creator using the corresponding client credentials, scopes, and access tokens.

Going forward

We’ll be provisioning the following in the near future — we’ll keep you all posted.
  • Adding the Creator scopes to the Zoho OAuth connection - DONE - about the scopes
  • v2 API-based Deluge tasks to integrate with Zoho Creator - DONE - Help Documents
  • Bulk APIs — APIs that will allow you to process records beyond the 200 limit

- - - - - - - -

Let us know your thoughts in the comments below.

Best,
Lakshman | Zoho Creator 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

                                                            • Introducing Zoho Creator's 2025 Release Projection 2

                                                              Hello Creators! I'm Prakash, from the Creator product management team, and today I'm delighted to unveil our next set of features as part of Release Projection 2 for 2025. With thoughtful analysis and planning, we've curated powerful new capabilities
                                                            • Zoho Creator - 2023 Release Projection 1

                                                              Hello everyone! A very Happy New Year to you and your family. Hope you're all good and having a great time using Zoho Creator to make your lives easier and your businesses prosper. 2022 was an action-packed year for us at Creator, and we hope to continue
                                                            • Zoho Creator User Group meetups in a city near you! - Oct - Nov, 2023

                                                              Greetings from the Zoho Creator team! We're hosting a series of Zoho Creator meetups in various cities across the globe, and we'd love to meet you there! Our meetups are a great opportunity to network with industry peers, exchange ideas and best practices,
                                                            • Zoho Creator - 2023 Release Projection 2

                                                              Hello everyone! Time truly flies when you're having an incredible journey, and today we mark the completion of an eventful and action-packed six months. It feels like just yesterday when we embarked on this adventure together with the launch of our new
                                                            • Upcoming Updates - August 2022

                                                              Hi all, Greetings from the Zoho Creator team! Today we've got news for you on some exciting updates. And rest assured— there’s more to come! In this post, we'll be going over the upcoming features and improvements for this month as mentioned below. A


                                                            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

                                                                                                              • No Automatic Spacing on the Notebook App?

                                                                                                                When I'm adding to notes on the app, I have to add spaces between words myself, rather than it automatically doing it. All my other apps add spacing, so it must be something with Zoho. Is there a setting I need to change, or something else I can do so
                                                                                                              • Holidays - Cannot Enter Two Holidays on Same Day

                                                                                                                I have a fairly common setup, where part-time employees receive 1/2 day's pay on a holiday and full-time employees receive a full day's pay. Historically, I've been able to accommodate this by entering two separate holidays, one that covers full-time
                                                                                                              • Zoho Bookings and Survey Integration through Flow

                                                                                                                I am trying to set up flows where once an appointment is marked as completed in Zoho Bookings, the applicable survey form would be sent to the customer. Problem is, I cannot customise flows wherein if Consultation A is completed, Survey Form A would be
                                                                                                              • Campaigns set up and execution assistance

                                                                                                                Hello Community, Can someone recommend a professional who can assist with the completion of my set up and deployment of Campaigns? Looking for a person or company that is not going to ask for big dollars up-front without a guarantee of performance to
                                                                                                              • Card Location in Zobot

                                                                                                                Hello, when using the “Location” card in a codeless builder Zobot, the behavior in WhatsApp is inconsistent. When asking the user to share their location, they can type a message, which will return the message “Sorry, the entered location is invalid.
                                                                                                              • Zobot with Plugs

                                                                                                                Hello, I am having a problem with Zobot using Plugs. Here is my current flow: When I run the flow, I should immediately see the messages from the initial cards (Send Message cards), then after running the plug, and finally, see the messages after the
                                                                                                              • Kaizen #223 - File Manager in CRM Widget Using ZRC Methods

                                                                                                                Hello, CRM Wizards! Here is what we are improving this week with Kaizen. we will explore the new ZRC (Zoho Request Client) introduced in Widget SDK v1.5, and learn how to use it to build a Related List Widget that integrates with Zoho WorkDrive. It helps
                                                                                                              • Remove Powered by Zoho at the footer

                                                                                                                Hi, I've read two past tickets regarding this but it seems that the instructions given are outdated. I assume the layout keeps on changing, which makes it frustrating for me to search high and low. Please let me know how exactly do I do this now? Th
                                                                                                              • Error AS101 when adding new email alias

                                                                                                                Hi, I am trying to add apple@(mydomain).com The error AS101 is shown while I try to add the alias.
                                                                                                              • No Need To Fix Something That Is Working

                                                                                                                Zoho Books is a great financial tool which helps businesses to become more efficient and productive with day-to-day operations. As such, every change, upgrade, improvement needs to be carefully thought before implemented in the software and I'm sure Zoho
                                                                                                              • Creating a task, i can not work out how to get ID for What_Id

                                                                                                                hi From Module A function I map Module B record reference membershipid (ours). I need Module B Zoho ID to create the related to on task. All examples i've seen start with the Zoho ID. void automation.LTM_Assign_Dispute_Task(String membershipid) { try
                                                                                                              • Using email "importance" as workflow-criteria

                                                                                                                I'd like to set up a workflow that triggers if an incoming email has been flagged as "high importance" but I'm not seeing any way to do that. Hopefully I'm just missing something obvious...?
                                                                                                              • This domain is not allowed to add. Please contact support-as@zohocorp.com for further details

                                                                                                                I am trying to setup the free version of Zoho Mail. When I tried to add my domain, theselfreunion.com I got the error message that is the subject of this Topic. I've read your other community forum topics, and this is NOT a free domain. So what is the
                                                                                                              • 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
                                                                                                              • Check & Unchecked Task Segregation in Export

                                                                                                                It must have a feature to represent checked and unchecked tasks as [ ] and [✅] respectively when exporting it to Arratai or WhatsApp ; as Keep Notes by Google contains…
                                                                                                              • WorkDrive Download Issue

                                                                                                                My client has been sending me files via WorkDrive, which generally has worked fine. Recently files won't download at all. If you try and individually select and download a file, a popup will appear in the bottom right saying it's preparing and then it
                                                                                                              • Feature Request: Add Tax ID Display on Event Tickets

                                                                                                                Hello Backstage Team, I’ve had several clients bring up an issue regarding tax compliance when creating events. For tax purposes, they are required to show their Tax ID on the event tickets. Currently, this isn’t an option, so they have to manually generate
                                                                                                              • Resolution Time Report

                                                                                                                From data to decisions: A deep dive into ticketing system reports What are time-based reports? Time-based reports are valuable tools that help us understand how well things are going by breaking down key metrics over specific periods. By tracking, measuring,
                                                                                                              • Support Custom Background in Zoho Cliq Video Calls and Meetings

                                                                                                                Hello Zoho Cliq Team, We hope you are doing well. We would like to request an enhancement to the video background capabilities in Zoho Cliq, specifically the ability to upload and use custom backgrounds. Current Limitation At present, Zoho Cliq allows
                                                                                                              • Add RTL (Right-to-Left) Text Direction Button in Zoho Cliq

                                                                                                                Greetings Zoho Team, We would like to request the addition of an RTL (Right-to-Left) text direction button in Zoho Cliq, similar to what is already available in other Zoho apps like Zoho Desk. Currently, while using Zoho Cliq with the English interface,
                                                                                                              • Enable Backgrounds and Video Filters for 1:1 Cliq Calls Across All Zoho Entry

                                                                                                                Hello Zoho Cliq Team, We hope you are doing well. We would like to request an enhancement related specifically to 1:1 video calls in Zoho Cliq. Current Behavior Zoho Cliq currently provides background and video filter options in the following scenarios:
                                                                                                              • Proposal: Actionable API Error Messages to Reduce Support Ticket Volume

                                                                                                                I've encountered a long-standing frustration with how Zoho Creator's API communicates errors to developers, and I'm hoping the Zoho team can address this in a future update. This issue has persisted for over 9 years based on community discussions, and
                                                                                                              • Zoho Flow: Stripe a Zoho Marketing Automation

                                                                                                                Hola! Quiero hacer un flujo con Zoho Flow, para que cuando se haga un pago en Stripe, añada el lead en Zoho Marketing Automation. Lo he configurado, configurando el disparador como "Payment created" y mapeando el campo de Stripe "Receipt email address".
                                                                                                              • Not able to delete a QC nor able to revert or create a cycle of manufacturing for QC failed Jobs

                                                                                                                Not able to delete a QC nor able to revert or create a cycle of manufacturing for QC failed Jobs
                                                                                                              • Need Customer Item Inward Module along with QC

                                                                                                                Need Customer Item Inward Module along with QC 1. Using Transfer Orders hit the item balance sheet 2. Items without inventory it becomes difficult for tracking purpose. 3. Custom Modules become tedious to capture multiple items, item subforms are not
                                                                                                              • LESS_THAN_MIN_OCCURANCE - code 2945

                                                                                                                Hi I'm trying to post a customer record to creator API and getting this error message. So cryptic. Can someone please help? Thanks Varun
                                                                                                              • Zoho email

                                                                                                                I need a list of email addresses of all contacts on my zoho
                                                                                                              • Error: Invalid Element tax_override_preference

                                                                                                                In both Books and Inventory, we're getting the following error whenever we try to enter any Bill: I think this is a bug. Even cloning an old bill (that obviously was entered just fine), this error occurs.
                                                                                                              • Shift-Centric View for Assigning and Managing Shifts in Zoho People

                                                                                                                Hello Zoho People Product Team, Greetings and hope you are doing well. This feature request is related to Zoho People - please don't move it to zoho one! We would like to submit a feature request regarding the shift assignment and management view in Zoho
                                                                                                              • Zoho Sheet for Desktop

                                                                                                                Does Zoho plans to develop a Desktop version of Sheet that installs on the computer like was done with Writer?
                                                                                                              • Introducing parent-child ticketing in Zoho Desk [Early access]

                                                                                                                Hello Zoho Desk users! We have introduced the parent-child ticketing system to help customer service teams ensure efficient resolution of issues involving multiple, related tickets. You can now combine repetitive and interconnected tickets into parent-child
                                                                                                              • cant upload images in signature- urgent help needed. ta!

                                                                                                                HI, I have been trying to insert the company logo in the signature. i have tried it several times since yesterday, the longest I waited was 1 hour and 12 minutes for the pop up window to upload a 180 KB .jpg file. what am i doing wrong.. an urgent reply
                                                                                                              • Add Ticket button in Home view

                                                                                                                When I go to the My Tickets or the Knowledge Base view in our Help Centre, the Add Ticket button is available, but not in the Home view. I would really like for it to be displayed in the Home view as well. Is this possible? Thanks.
                                                                                                              • Problem using Zoho Desk API

                                                                                                                Goodmorning, I am trying to use the Zoho Desk API to create a dashboard in Grafana, but I am having a problem. Following the instructions in the API documentation, I created the API Console application (server-based application). Then I created the string
                                                                                                              • Add zoho calendar to google calendar

                                                                                                                Hi I keep seeing instructions on how to sync Zoho CRM calendar with google calendar but no instructions on how to view Zoho calendar in my google calendar.
                                                                                                              • How to print a label from zoho creator app?

                                                                                                                Hello, I would like to print a label from zoho creator app record similar to attached one. Size 74mm x 102mm. I tried record template. It leaves plenty of space around the content and also I couldn't set the height of the page. So it is not printing properly. Could someone please direct me to right direction for this requirement?
                                                                                                              • City field suggestion in Zoho Books

                                                                                                                Hi team, We are using Customers module in Zoho Books. In the Address section, we want to understand whether the City field can show suggestions while typing using any API or built-in feature. For example, if a user types “Mum”, can the system suggest
                                                                                                              • Non-responsive views in Mobile Browser (iPad)

                                                                                                                Has anyone noticed that the creator applications when viewed in a mobile browser (iPad) lost its responsiveness? It now appears very small font size and need to zoom into to read contents. Obviously this make use by field staff quite difficult. This is not at all a good move, as lots of my users are depending on accessing the app in mobile devices (iPads), and very challenging and frustrating. 
                                                                                                              • How can I check all announce?

                                                                                                                Hiii, May I ask how can I check all the announce based on broadcast date instead of reply date based So that I will not will miss out any new function
                                                                                                              • How to apply customized Zoho Crm Home Page to all users?

                                                                                                                I have tried to study manuals and play with Zoho CRM but haven't found a way how to apply customized Zoho CRM Home Page as a (default) home page for other CRM users.. How that can be done, if possible? - kipi Moderation Update: Currently, each user has
                                                                                                              • Next Page