Introducing Version-3 APIs - Explore New APIs & Enhancements

Introducing Version-3 APIs - Explore New APIs & Enhancements

New Update - The end of life timeline for V2 APIs has now been extended to 30th June, 2026


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.
 
    • Sticky Posts

    • Enhanced Collaboration and Global Web Tabs

      Hello Users, We are rolling out two key enhancements in Zoho Projects that will be part of our November release. Here’s what to expect: 1. Collaboration Section in the Left Navigation Panel What’s new? All communication and interactive tools will be grouped
    • Choosing the Right Automation in Zoho Projects

      In any project, different types of actions are needed at different points. Some projects require control on how tasks move, some require reacting to updates, and some require executing additional actions beyond the task. Automation in Zoho Projects is
    • Introducing Version-3 APIs - Explore New APIs & Enhancements

      New Update - The end of life timeline for V2 APIs has now been extended to 30th June, 2026 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.
    • CodeX Scripts for Enforcing Custom Project Logic

      Every organization has a defined way of executing projects. There are clear expectations around how tasks should move, when projects should progress, and which actions require validation. When these rules are consistently followed, projects remain structured
    • Automation Series: Auto-create Dependent Task on Status Change

      In Zoho Projects, you can automatically create and assign a dependent task when a task’s status is updated. This helps teams stay aligned, ensures reviews happen on time, and reduces manual effort. In this post, we’ll walk through an easy setup using
    • Recent Topics

    • Unattended - Silent

      How can I hide the tray icon / pop up window during unattended remote access for silent unattended remote access?
    • What is the Potential field for in expense submissions?

      I'm trying out Zoho Expense in Zoho Project so I can record project expenses which aren't time related. On the expense form there is an option called Potential but I don't understand what this is for. When I click the dropdown it just shows the name of
    • Pasting Images in Zoho Desk ignores cursor location

      My team has reported an issue which started recently where when we paste an image into a new or existing reply or comment, the pasted image seems to ignore the current cursor location instead paste itself at the last character present in the reply/comment,
    • Control Fields on Mobile App

      On the mobile app, how do we control which fields appear on the screen for records that have a related list? In the example below I want the Inspection Stage and Inspection Type fields to appear, not the record owner (Dev Admin). I changed the Inspections
    • Unable to switch existing AWS RDS connection to DataBridge after moving RDS behind VPN

      Hi everyone, I’m facing a problem with an existing Zoho Analytics setup and would like to know the best migration path. Originally, my Zoho Analytics connection to AWS MySQL RDS was configured using direct public access to the RDS endpoint. Everything
    • Hotmail

      I am sending an email to a hotmail, and this guy does not receive the email, either in his SPAM nor inbox. Can you help me? thanks!
    • No Ability to Rename Record Template PDFs in SendMail Task

      As highlighted previously in this post, we still have to deal with the limitation of not being able to rename a record template when sent as a PDF using the SendMail Task. This creates unnecessary complexity for what should be a simple operation, and
    • how do i add more than one google my business location?

      they are connected to one account, but while connecting social channels it makes me pick one location. I have 3 and growing.
    • Updating Sales orders on hold

      Surely updating irrelevant fields such as shipping date should be allowed when sales orders are awaiting back orders? Maybe the PO is going to be late arriving so we have to change the shipment date of the Sales order ! Not even allowed through the api - {"code":36014,"message":"Sales orders that have been shipped or on hold cannot be updated."}
    • Need to make a specific canvas my default view for contacts

      Need to make a specific canvas my default view for contacts How do I do it?
    • How do I change the Subject header when I reply please, it contains Re which I want to remove.

      Hi Zohodesk, When a customer logs a call we have amended the Acknowledge on new Ticket template so the subject header has "Ticket Id" at the start of it.  When we reply the customer gets Re: and then the Id and I can't see a template for this? Can you
    • Zia Agent built in ChatKit UI does not render markdown

      Hi, You have a major shortcoming in the Zia Agent UI. The test UI that is embedded in agents.zoho.com allows you to test the agent has full support for rendering markdown, but your ChatKit UI does not have support for rendering markdown. If I embed it
    • Automated entries past the current month in a calendar report

      Hi all, I have an automation problem. I have a form which on successfull entry adds either 5 or 10 more of these entries with a slight change so our customers can see it throug a calendar report on the webiste. The entry put in manually shows up perfectly
    • [Bug] WebAuthn passkey registration blocked on rpIds with TLDs longer than 6 characters (.accountant, .technology, etc.) — isValidDomain regex too strict

      Hi, Filing on behalf of an enterprise customer where Zoho Vault is deployed across the company. The Chrome extension blocks WebAuthn passkey registration on legitimate sites whose Relying Party ID (rpId) has a TLD longer than 6 letters. This affects every
    • Get Files Associated to Data Template via API

      I have a data template with multiple files associated to it, and trying to write a Deluge script that will fetch files associated with this data template. I created the script below based on the WorkDrive API documentation, one request uses the data templates
    • ZOHO CRM User management or role

      I need guidance regarding Zoho CRM licensing and user management. I want to purchase one Zoho CRM license and create multiple team users under the same account with the following hierarchy: Super Admin User Manager User Executive Users (with limited access)
    • Tip #72 - Exploring Technician Console: Setup Unattended Access - 'Insider Insights'

      Hello Zoho Assist Community! You joined a live session, diagnosed the issue, and got the user back on track. Fix delivered, user happy, session closed. But you know this machine. It needs a follow-up. A cleanup, a patch, maybe a deeper maintenance run.
    • #1 New to Zoho Invoice? Do this First!

      "Zoho Invoice has made our company's tax invoices look more elegant and professional. It is effortless to raise an invoice and track payments with it", says Arunkumar Balakrishnan, Director GA Technologies. Generating professional invoices usually begins
    • Mastering Zia Match Scores | Let's Talk Recruit

      Feeling overwhelmed by hundreds of resumes for every job? You’re not alone! Welcome back to Let’s Talk Recruit, where we break down Zoho Recruit’s features and hiring best practices into simple, actionable insights for recruiters. Imagine having an assistant
    • Automation Series #5: Supervisor Rule vs Schedule in Zoho Desk

      Supervisor Rules vs Schedules: Choosing the right time-based automation This post is part of the "Desk Automation Series," Chapter 1. Through this series, we will help you choose the right automation type in Zoho Desk by comparing commonly confused automations
    • Error when changing user permission from read only to user.

      Hi there, Ive tried to change one of my users to be able to edit, however i kept getting the error user license exceed.
    • Add Zia matching jobs on the main screen of candidates module

      It will be good if it is added in the main screen as a column so that we can quickly hover over and see if they match for any job openings. That will save from two additional clicks
    • Insert Template not inserting

      I have been using the "Insert Template" feature for years and I use it every single working day. Yesterday it was working fine. Today, on two different browsers (Chrome and Edge), I can select "Insert Template", select the template I want to insert, but
    • Need Help Preventing Overselling in Zoho Inventory

      Hi fellow Zoho Inventory users, I'm reaching out for advice on managing inventory control in our growing business. We've recently encountered situations where sales orders get confirmed despite insufficient stock, creating operational challenges. Our
    • Conditional Layouts On Multi Select Field

      How we can use Conditional Layouts On Multi Select Field field? Please help.
    • Smart Feature Compatibility Indicators for CRM Field

      Zoho CRM offers a wide range of field types and advanced customization options. However, several field types have feature-specific limitations that are currently documented only in help articles. For example, while configuring a Rich Text field, admins
    • Deactivate Zoho CRM for everyone

      We would like to deactivate Zoho CRM for everyone. How can we do that?
    • Best sales insights for target accounts?

      Question for all the sales power-users out there: I would like to gain insights from Zoho CRM for a rotating list of target accounts. Each Outside Salesperson has 5 target accounts, and they can change these targets quarterly with management approval.
    • Building extensions #2: Publishing and sharing Zoho Sprints extensions using Sigma Cloud Editor

      Welcome to a new post on Zoho Sprints extension development! In our last post, we explored how to create, test, and edit an extension for Zoho Sprints. In this post, we'll take a look at how to publish and share an extension. Publishing and sharing extensions
    • Set Custom Icon for Custom Modules in new Zoho CRM UI

    • Custom return paths

      How do I delete a custom return path subdomain created in error?
    • How do you paginate in schedule function

      How does someone paginate in schedule function in deluge is there an ideal way to do this apart from hardcoding max pages
    • Mail bounces due to bad reputation

      Good evening. I'm seeing these errors from both hotmail/outlook and yahoo, as well as hard bounce from Virgin Media and talktalk for some time now. Bounce category: Connection issues Reason: uncategorized-bounce Message: 4.7.650 The mail server [136.143.188.237]
    • What is a realistic turnaround time for account review for ZeptoMail?

      On signing up it said 2-3 business days. I am on business-day 6 and have had zero contact of any kind. No follow-up questions, no approval or decline. Attempts to "leave a message" or use the "Contact Us" form have just vanished without a trace. It still
    • Calendar in Global View

      When you are working with multiple projects, staying on track with all project activities requires a centralized view of all your project activities. Especially in a work environment, users tend to miss out on their day-to-day activities when it doesn't
    • My email sending has beed blocked due to high bounce rate. NEED HELP

      User ID: 886739811 Dear Zoho Team, I hope this message finds you well. My account (User ID: 886739811) was blocked from sending emails last week due to an unusually high bounce rate. This spike was caused by a bot attack on our platform, which led to
    • 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
    • What is the difference between workflows, journeys, and blueprints?

      I semi-understand what they are individually but they all say they can be used to automate processes in your CRM. What makes these three different? What are the benefits and cons of using each?
    • How to Migrate from MDaemon to Zoho Mail Account?

      Hi there, Zoho Mail is one of the most popular as well as leading competitor for several cloud email service providers. It is It provide cloud email service as well as desktop based email client. In recent years people are migrating from third party cloud servers to Zoho Mail. The reasons are plenty, i.e. the user interface, security, high performance and many countless amazing features. On the other hand MDaemon Mail (aka WorldClient) is also popular among cloud email servers. But there are some
    • Ask the Experts: A Live Q&A Session

      We’re back with another exciting edition of the Ask the Experts series, this time exclusively for our Zoho Recruit users from the USA & Canada regions! Whether you're trying to configure your account better, have questions about customization, or want
    • Next Page