Introducing Version-3 APIs - Explore New APIs & Enhancements

Introducing Version-3 APIs - Explore New APIs & Enhancements

Happy to announce the release of Version 3 (V3) APIs with an easy to use interface, new APIs, and more examples to help you understand and access the APIs better.

V3 APIs can be accessed through our new link, where you can explore our complete documentation, sample inputs and responses, and integration-related operations.

Please note that the old APIs will be supported until December 31, 2025.

Here’s what’s new: 

New APIs 

The ISO date and time format is followed in all the new APIs to ensure consistency.
Create, update, delete, and execute task blueprints.
Retrieve, upload, associate, and disassociate project attachments.
Retrieve, add, update, and delete leave records.
Manage portal profiles, permissions, and default profile settings.
Create, update, delete, and assign default user roles.
Manage client details, project associations, and updates.
Configure module layouts, sections, and fields.
 

 Enhancements 

1. JSON Objects for API Keys

  • API keys, such as created_by_name, created_by_zpuid, module_name, module_id, tasklist_id, and tasklist_name, are now unified under a single JSON object to improve readability.
  • This ensures standardized and complete information retrieval.
  • Users can append values to JSON objects to include additional keys as needed.

2. Filter with 'OR' Condition

  • You can use OR conditions in criteria and filters for more refined queries.
  • The filtering mechanism supports api_names or cfid, allowing AND/OR combinations.
Example:   
 
     "criteria": [ 
         {"cfid": "1", "criteria_condition": "is", "value": ["5000000045047"]}, 
         {"cfid": "2", "criteria_condition": "is", "value": ["5000000256013"]} 
     ], 
     "pattern": "1 OR 2" 
 } 

3. Standardized Responses for Create & Update APIs

  • Responses match input formats, ensuring consistency and clarity. Both, request and response, follow the same JSON structure.
  • Update APIs now use the PATCH method instead of POST, aligning with RESTful best practices by updating only the necessary fields rather than replacing the entire resource.

4. Custom Fields with API Names

  • Custom fields support API names for easier identification. Currently supported in Projects and Tasks module APIs.

5. GET APIs

  • Input remains parameter-based, while output is in JSON format.
  • Almost all modules now provide access to their corresponding fields, matching what you see in the UI.

Pagination Support

GET APIs now support pagination with the following parameters:
  • page (integer): Specifies the page number to fetch.
  • per_page (integer): Specifies the number of entries per page.
Example Response: 
 
     "page_info": { 
         "page": 1, 
         "per_page": 10, 
         "page_count": 10, 
         "has_next_page": true 
     } 
 } 

       Sorting Mechanism

Sort results in ascending (ASC) or descending (DESC) order using the sort_by parameter.

Example usage:
sort_by=ASC(created_time) → Sorts results in ascending order based on created_time.
sort_by=DESC(last_modified_time) → Sorts results in descending order based on last_modified_time.

Example API Request:   
GET /api/resource?page=1&per_page=10&sort_by=DESC(last_modified_time) 

6. Improved UI Experience

  • API types are now color-coded for easy identification.
  • Each API includes detailed examples for better implementation and usability.

These updates improve our APIs for a more seamless experience. Try them out and share your feedback! You can also write to support@zohoprojects.com.
 

    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

                                                            • Zoho Projects - Quarterly Updates | Q1 2025

                                                              Hello Users, We would like to share the latest updates for this quarter. Here is a round-up of the features and enhancements we rolled out in Q1: Working with Zoho Projects data in Power BI? Integrate Zoho Projects to Power BI and sync module data (from
                                                            • Analyze Project Trends with Power BI Integration for Zoho Projects

                                                              Integrate Microsoft Power BI with Zoho Projects to sync project data, create reports, and analyze trends. This integration allows you to track key project metrics and share insights with your stakeholders. Managing multiple projects requires clear visibility
                                                            • Customize User Invites with Invitation Templates

                                                              Invitation Templates help streamline the invitation process by allowing users to create customized email formats instead of sending a one-size-fits-all email. Different invitation templates can be created for portal users and client users to align with
                                                            • Introducing Version-3 APIs - Explore New APIs & Enhancements

                                                              Happy to announce the release of Version 3 (V3) APIs with an easy to use interface, new APIs, and more examples to help you understand and access the APIs better. V3 APIs can be accessed through our new link, where you can explore our complete documentation,
                                                            • Time Based Workflow Rules for Projects and Tasks

                                                              Project managers spend a significant amount of time manually monitoring task deadlines, notifications, and follow ups. Zoho projects' Workflow Rules help automate these repetitive processes and save valuable time. Workflow rules are a set of actions that


                                                            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 Writer

                                                                                              Get Started. Write Away!

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

                                                                                                Zoho CRM コンテンツ










                                                                                                  Nederlandse Hulpbronnen


                                                                                                      ご検討中の方




                                                                                                            • Recent Topics

                                                                                                            • Create Funnel to Track Email Outreach Conversion

                                                                                                              Hello, We would like to create a funnel that measures: N° of emails sent -> N° of emails opened -> N° of emails responded We would like to measure this email response conversion rate for each of our SDRs. We use the analytics tool of Zoho CRM and not
                                                                                                            • Schedule Zoho CRM reports only on Business Days

                                                                                                              Hello, Is it possible to schedule reports only on business days ? We currently get daily sales reports on weekend which has no value since the sales team doesn't work on weekends. Thanks
                                                                                                            • Presenting the brand new Zoho Bookings!

                                                                                                              Hello everyone, Greetings from Zoho Bookings! We're happy to announce a new version of our product with enhanced features to simplify scheduling, coupled with a sleek interface and improved privacy across teams. Here's what you can expect from the latest
                                                                                                            • Zoho CRM - Rollup Field for "Total Calls TODAY"?

                                                                                                              Good afternoon, I'm trying to build a field that will track the total number of calls made to a lead in one day. This way i can organise my call queues by this to prioritise leads without an attempt. I can put in a Rollup field for *total* calls made
                                                                                                            • Cliq iOS can't see shared screen

                                                                                                              Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? Regards
                                                                                                            • Feature Request Improve parent-child relationship visibility

                                                                                                              Hi team, The Parent-Child ticket feature is great, but I've struggled to see the relationship between tickets when using ticket list views. It would be a great quality of life enhancement for users if child tickets were nested under parent tickets in
                                                                                                            • Company Name Update and Chatbot Customization

                                                                                                              We would like to request your assistance with the following updates to our Zoho system: Company Name Change: we have integrated chatbot on our website. Please help to change our company name from BVK Infrasoft to BVK Group on chatbot the entire system,
                                                                                                            • Zoho Payroll: Product Updates | April 2025

                                                                                                              At Zoho Payroll, we’re always working to make every payday feel effortless. And sometimes, that means listening closely to your unique needs. This month, we’ve focused on adding features that give you the flexibility to pay your employees based on your
                                                                                                            • Creating task at someones date of birth

                                                                                                              Hi, I want to create a workflow which creates a task at someones date of birth. How can I do this?
                                                                                                            • How do I do a formula to join two fields together like first name and last name into full name?

                                                                                                              Having issues with this in my custom module.  In most CRM systems you would do: FIELD1 & " " & FIELD2 But it gives an error saying I'm not supposed to use double quotations so not sure what that means.  I've tried to read the formula help guide but it's
                                                                                                            • Call transcrition working for ringcentral?

                                                                                                              I don't see anything about what telephony providers can be used. The Zoho support person A said that RingCentral isn't supported. Zoho support person B said that it works, just make sure the call recording link works. Excellent instructions here: Call
                                                                                                            • Zoho CRM in Microsoft Power Automate Custom Data Connector

                                                                                                              Hello, I have set up a custom data connector in Microsoft Power Automate. It is a connector to retrieve Zoho CRM data. I am pretty certain that I have entered the OAuth 2.0 authentication information correctly. However when I test the Get request https://zohoapis.com/crm/v2/leads.
                                                                                                            • How do i move multiple tickets to a different department?

                                                                                                              Hello, i have several tickets that have been assigned to the wrong department.  I am talking about hundreds of automatically generated ones that come from a separate system. How can i select them all at once to move them to another department in one go? I can select them in "unsassigned open tickets view" but i can't find a "move to another department" option. I also can't seem to assign multiple tickets to the same agent in that same view. Could somebody advice?
                                                                                                            • validation function for Stage QC means QC Done fileupload field not empty on Save

                                                                                                              validation function for Stage QC means QC Done field field not empty . if the fileupload has value also it showing the false statement on save how i fix this Also one more concern is Custom validation function work on blue print transaction. ///this is
                                                                                                            • Mobile App Location Features (Check-in, Maps) Not Working for Tasks Related to Deals (Address Data Copied via Function)

                                                                                                              Hello Zoho Community, I'm facing an issue with the Zoho CRM mobile app's location-based features (like check-in suggestions or map pins) specifically for Tasks related to Deals. Goal: I want the mobile app's location features to work for Tasks related
                                                                                                            • Zoho Support - Again!

                                                                                                              I've been using Zoho One for over 5 years and it seems the level of support just goes from bad to worse. The only thing that has kept me with them this long is the product itself. When something goes wrong, it is a mandatory 2 days wait for a response
                                                                                                            • Quick Create needs Client Script support

                                                                                                              As per the title. We need client scripts to apply at a Quick Create level. We enforce logic on the form to ensure data quality, automate field values, etc. However, all this is lost when a user attempts a "Quick Create". It is disappointing because, from
                                                                                                            • Not Able to access Api of Zoho Workdrive.

                                                                                                              I have Zoho One plan. And I am trying to use api of Zoho workdrive and Showing Invalid Client.
                                                                                                            • Map Contact to Account record based on email domain

                                                                                                              Hi Community, I'm looking for a (presumably custom) solution to map Contact records to Accounts based on web domain. E.g. new Contact record John Smith with email john.smith@acme.com is automatically mapped to Account record Acme Ltd https://acme.com
                                                                                                            • Edit Project Number?

                                                                                                              Hi all: We just signed up for a trial of zoho one, which includes ZoHo Projects. We've noticed there was a 'dummy project' preloaded in projects to help familiarize yourself with the software. We've created a couple of our own projects now but noticed since the dummy project was preloaded, our projects start with number 2 then 3, sequentially. Since it seems we will be keeping zoho past the trial, If we delete the dummy project, how do we get our own projects renumbered, beginning with 1? We'd like
                                                                                                            • How to integrate single-sign-on using Linkedin in Zoho Creator

                                                                                                              How to integrate single-sign-on using LinkedIn in Zoho Creator need step by step integration.
                                                                                                            • Canvas responsive preview in different browser window causes re-authentication/verification

                                                                                                              I'm trying to design a view in Canvas. I am testing in a tab with a desktop view, and another tab (on my same desktop/IP) with a responsive view of an iphone. Every time I refresh, it boots me out of the previously used tab. If I forget to refresh the
                                                                                                            • The Next Chapter for CRM for Everyone: Moving from Early Access to Phased Rollout for Customers

                                                                                                              #CRM25Q1 Hello Everyone, Until now, CRM for Everyone has been available in early access mode exclusively for users who opted to try the new version. We are now transitioning to a phased release, starting with the basic edition. We are thrilled to announce
                                                                                                            • Second Insight - Let's talk Layouts

                                                                                                              The Wheels of Ticketing - The Desk Stories Let's talk Layouts What are layouts? Layouts refer to the arrangement or design of elements in a space, whether on a physical surface, like a room or a piece of furniture, or in digital contexts, such as web
                                                                                                            • Generate a Zoho Sign link

                                                                                                              From time to time I get a response "I never received your you e-document for electronic signature" is there a way to generate a Zoho Sign link to share.
                                                                                                            • 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
                                                                                                            • Trigger a Workflow Function if an Attachment (Related List) has been added

                                                                                                              Hello, I have a Case Module with a related list which is Attachment. I want to trigger a workflow if I added an attachment. I've seen some topics about this in zoho community that was posted few months ago and based on the answers, there is no trigger
                                                                                                            • Week date range in pivot table

                                                                                                              Hello, I need to create a report that breakouts the data by week.  I am using the pivot table report, and breaking out the date by week, however the date is displayed as 'Week 1 2014' format.  Is there anyway to get the actual dates in there? ex. 1/6/2014-1/12/2014 Thanks,
                                                                                                            • Canvas Flex Box containers should not require a width/height.

                                                                                                              Flexbox containers are often used as organizational concepts, to ease re-flow on mobile etc. - I cannot use % for flexbox W or H - I cannot omit W or H This means that the content cannot dictate, and a Flexbox container cannot be used merely as an organizational
                                                                                                            • Zoho Error: This Operation has been restricted. Please contact support-as@zohocorp.com for further details

                                                                                                              Hello There, l tried to verify my domain (florindagoreti.com.br) and its shows this error: This Operation has been restricted. Please contact support-as@zohocorp.com for further details. Screenshot Given Below -  please check what went wrong. Thanks
                                                                                                            • Data Retention Policy Update – Effective May 1, 2025

                                                                                                              Starting May 1, 2025, we’re updating how long we store your landing page data based on your subscription plan. Here’s the new retention timeline: Trial Plan – 3 months Essentials Plan – 6 months Professional Plan – 9 months Enterprise & Bundle Plans –
                                                                                                            • Backup and Restore of Projects

                                                                                                              Hi Guys, my boss asked me "do we store regulary offline Backups of Zoho Projects" and i could only answer "no way". Is there really no way to backup and restore a project manualy? As Projects is the main Product we decided to use Zoho it could be that
                                                                                                            • Tip of the Week #52 – Use keyboard shortcuts!

                                                                                                              Tired of clicking around often? Navigating can feel slow when you’re switching between threads, views, or composing messages, all using just your mouse. Turn on Keyboard Shortcuts to move around your inboxes faster and work smarter. Once enabled, you
                                                                                                            • FSM Job Sheets data to CRM

                                                                                                              Hello, is there anyway of getting the data collected in the job sheets into the CRM. We are collecting inspection data which we were using zoho forms for but the job sheets in fsm seem like a lot better way to collect it but we need to be able to get
                                                                                                            • An update to improve email delivery | Email Authentication & Relay

                                                                                                              Update Rollout For Trial Users (signed up on or after April 8, 2025) If your email-sending domain is not authenticated, all emails will be sent from Zoho Recruit's authenticated domains by default. This update is now live across all data centers. Once
                                                                                                            • Shopify sales orders creating a new account in Zoho

                                                                                                              Hi all, I am having a slight issue with the shopify integration. Whenever a customer purchases from the store, shopify automatically creates a sales order in inventory. The issue is that it creates a new account for the customer's name instead of attaching
                                                                                                            • Open a popup window from inside Record A and stay on the record after saving Record B

                                                                                                              Hello community, Perhaps you can help me with the following topic. I have a form A with a decision box. When this decision box is checked, a form B pops up. Once Form B is saved, I need to stay on Form A to continue entering data. I've observed the following
                                                                                                            • Random Email Missing for specific domians

                                                                                                              Our mail service randomly fails to receive emails. When certain domains proactively send emails, our sales team reports that they haven’t received those messages from clients. This creates a financial risk for us in certain cases. We’ve already submitted
                                                                                                            • Payroll in Saudi Arabia

                                                                                                              Zoho is a popular software platform that offers a wide range of business solutions, from customer relationship management to finance and accounting tools. However, one major drawback for businesses operating in Saudi Arabia is the lack of a payroll feature
                                                                                                            • CRM Hack #3: How to update formula functions for already created records.

                                                                                                              Hello everyone! It’s Wednesday and we are back with yet another hack.. I'm sure you've used formula fields to meet some requirements specific to your business. Let's consider an example each for external (customer-facing) and internal facing scenarios
                                                                                                            • Next Page