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

    • 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
    • Time Log Reminder

      Tracking the time spent on tasks and issues is one of the most important functions of a timesheet. However, users may forget to update the time logs because they have their own goals to achieve. But, time logs must be updated at regular intervals to keep
    • Introducing the Zoho Projects Learning Space

      Every product has its learning curve, and sometimes having a guided path makes the learning experience smoother. With that goal, we introduce a dedicated learning space for Zoho Projects, a platform where you can explore lessons, learn at your own pace,
    • Update on V2 API End-of-Life Timeline

      Dear Users, Earlier this year, we shared the launch of the V3 APIs and requested users to migrate from the older V2 APIs by December 2025. We have received valuable feedback from our users and partners regarding their migration timelines. We are happy

    Nederlandse Hulpbronnen


      • Recent Topics

      • Zoho CRM - Option to create Follow-Up Task

        When completing a Zoho CRM Task, it would be very helpful if there was an option to "Complete and Create Follow-Up Task" in the pop-up which appears. It could clone the task you are closing and then show it on the screen in edit mode, all the user would
      • Deluge function to copy parent record file upload field to child record file upload field

        I'm stuck trying to write a deluge function that is triggered via automation in child record "Appointments," confirms if a file is in file upload "Report" field of parent "Contacts" record via Contacts lookup field "Contact_Name". If no file is in parent
      • Make panel configuration interface wider

        Hi there, The same way you changed the custom function editor's interface wider, it would be nice to be able to edit panels in pages using the full width of the screen rather than the currently max-width: 1368px. Is there a reason for having the configuration panel not taking the full width? Its impossible at this width to edit panels that have a lot of elements. Please change it to 100% so we can better edit the layouts. Thanks! B.
      • Image Compression Options

        Much better if we have level of options to compress the image [20%, 40%...] We are dealing with service reports daily that has before and after photos (image field)- the file size too large and one thing, the current limit is 10mb or 15mb for report
      • How to hide or archive a blog post temporarily in Zoho commerce website builder?

        I would like to temporarily hide or archive a blog post in zoho commerce website builder so that it doesnt appear on my website till I enable it again. I tried to look for this option but could not find it.  It only allows me to permanently delete a blog
      • How to mix different types of inputs (such as dropdown list and textbox)

        Hi, I'm creating a form called "Room Reservations" for a company. I created a "table" using "Matrix Choice". I created "Room 1", "Room 2" and "Room 3" with the "Questions". I would then like to create two columns with the "Answers", one called "Department"
      • Zoho Commerce - Poor Features Set for Blogging

        Hi Zoho Commerce team, I'm sure you will have noticed that I have been asking many questions about the Blogs feature in Commerce. I thought that it would be useful if I share my feedback in a constructive way, to highlight the areas which I feel need
      • Pass shipping info to payment gateway Zoho Books to Authorize.net

        For some reason the integration from Zoho books to Authorize.net does not pass the shipping address. Authorize.net is ready to receive it, but zoho books does not send it
      • Massive Zoho Books failure

        We have not received any communication or notification from Zoho, but we have detected that Zoho Books is not working for all our users. We cannot access or use Zoho Books. This is critical. We are trying to contact Zoho on the Spain telephone number,
      • Does the Customer “Company Name” field appear anywhere in the Zoho Books UI outside of PDFs?

        Hi everyone, I’m trying to understand how the Company Name field is actually used in Zoho Books. There is a Company Name field on the customer record, but when viewing transactions like a Sales Order in the normal UI (non-PDF view), that field doesn’t
      • Email outbox is now available in the sandbox

        Hello all! Testing emails without visibility has always been a blind spot in the sandbox. With the new Outbox, that gap is closed. You can now view and verify every email triggered from your sandbox, whether it’s through workflows, approvals, or mass
      • Looking For Recruit Developer

        Hi everyone, I am looking for a Zoho Certified Developer to assist with a development project for MetalXpert. We are building a software system designed to bridge the gap between a candidate mobile app and an employer web portal using Zoho Recruit as
      • sales IQ issue on website

        i integrated the zoho sales IQ code on the website but it is comming in distroted form i am sharing the screenshot below the website is bulit in wix platform
      • I need to know the IP address of ZOHO CRM.

        The link below is the IP address for Analytics, do you have CRM's? IP address for Analytics I would like to know the IP address of ZOHO CRM to allow communication as the API server I am developing is also run from CRM. Moderation Update: The post below
      • Important Update: Google Ads & YouTube Ads API Migration

        To maintain platform performance and align with Google's newest requirements, we are updating the Google Ads and YouTube Ads integrations by migrating from API v19 to the newer v22, before the official deprecation of v19 on February 11, 2026. Reference:
      • Blocklist candidates in Zoho Recruit

        We’re introducing Block Candidate, which helps recruiters to permanently restrict a candidate from applying to current/future job openings. Once the candidate is blocked, they will no longer be able to participate in the recruitment process. This will
      • Zoho Desk - Upsert Ticket

        Hi Desk Team, It is common to request more information from end-users. Using forms is a great way to ensure all the required information is collected. It would be great if there were an "upsert" option on the Zoho Form -> Zoho Desk integration which would
      • Client Side Scripts for Meetings Module

        Will zoho please add client side scripting support to the meetings module? Our workflow requires most meeting details have a specific format to work with other software we have. So we rely on a custom function to auto fill certain things. We currently
      • Introducing Multiple Sandbox Types and Support for Module's Data Population

        Register here for the upcoming Focus Group webinar on Multiple Sandbox | Help documentation to learn more about the new enhancements Hello everyone,  Sandbox in CRM is a testing environment for users to create and test new configurations like workflow
      • Creator Offline

        We had online access setup and working on our iphones. We have just set it up on an 'Android Tablet' and it is not downloading all the images? We use it to show customers our catalogue. Any ideas. Offline components all setup on both devices
      • Enable or disable any Field Rule!

        Hello Zoho Forms Community, We are excited to announce a powerful new enhancement to Field Rules that gives you greater control and flexibility in managing your form logic! Previously, if you wanted to temporarily deactivate a field rule, you had two
      • Marketing Tip #20: Increase traffic with strong meta titles and descriptions

        Meta titles and descriptions are what people see first on search results before they ever click through to your website. If your pages use generic titles or basic descriptions, you miss the chance to stand out, and search engines may not know which page
      • Kanban view on Zoho CRM mobile app!

        What is Kanban? The name doesn't sound English, right? Yes, Kanban is a Japanese word which means 'Card you can see'. As per the meaning, Kanban in CRM is a type of list view in which the records will be displayed in cards and categorized under the given
      • 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
      • Dheeraj Sudan and Meenu Hinduja-How do I customize Zoho apps to suit my needs?

        Hi Everyone, I'm Meenu Hinduja and my husband Dheeraj Sudan, run a business. I’m looking to tweak a few things to fit my needs, and I’d love to hear what customizations others have done. Any tips or examples would be super helpful! Regards Dheeraj Sudan
      • is there any way to change the "chat with us now" to custom message?

        is there any way to change the "chat with us now" to custom message? I want to change this text
      • Subscriptions for service call

        So we install products and we want to offer a service contract for the customers yearly service calls to be billed monthly. So ideally at some point we want to email them a quote for their needs. WE will choice it our end based on the equipment. It would
      • Connection to other user

        Zoho Cliq handles sharing of Custom OAuth Connections that require individual user logins.
      • How to invite friends on other social media platforms to one of my group chats in arattai?

        Hello, I have formed chat groups in arattai. I want to invite my friends on other social media platforms like WhatsApp/ FB to one of my groups. Different friends would be invited to different groups. How to share an invite link of one of my groups to
      • Zoho Books (UK) needs to be able to submit a CT600 CTSA return

        As well as a VAT Return, most (if not all) small businesses have to submit a CT600 Corporation Tax Self-Assessment. There are many providers who do this (like Xero) bujt not Zoho. Can you add this to the request list please? Many thanks Steve
      • Cliq does not sync messages after Sleep on Mac

        I'm using the mac app of Cliq. When I open my mac after it was in sleep mode, Cliq does not sync the messages that I received. I always have to reload using cmd + R, which is not what I want when using a chat application.
      • Function #2: Create a Deal in Zoho CRM when an Estimate is created in Zoho Books

        For those who use Zoho CRM integrated with Zoho Books, here's a nifty function that helps you optimize your sales process by adding a Deal in Zoho CRM whenever an estimate is created in Zoho Books. Custom Function: To create the custom function, go to
      • Analytics : How to share to an external client ?

        We have a use case where a client wants a portal so that several of his users can view dashboards that we have created for them in Zoho Analytics. They are not part of our company or Zoho One account. The clients want the ability to have user specific,
      • Payroll and BAS ( Australian tax report format )

        Hello , I am evaluating Zoho Books and I find the interface very intuitive and straight forward. My company is currently using Quickbooks Premier the Australian version. Before we can consider moving the service we would need to have the following addressed : 1.Payroll 2.BAS ( business activity statement ) for tax purposes 3.Some form of local backup and possible export of data to a widely accepted format. Regards Codrin Mitin
      • Zoho Desk API - Send Reply to CUSTOMERPORTAL

        Hello! I'll try to send a reply to Customer Portal, But the response is 500 (INTERNAL_SERVER_ERROR in service response). {"Error":"{\"errorCode\":\"INTERNAL_SERVER_ERROR\",\"message\":\"An internal server error occurred while performing this operation.\"}"}
      • Issue with open-rate reporting in Zoho Campaigns

        Hello, Since yesterday I’ve been experiencing an issue with the open-rate reports in Zoho Campaigns. The campaigns I send appear in the reports as if none of the emails have been opened, even though I know they have. To verify this, I replicated the campaign
      • Best practices for managing Project Charters, Business Case and RAID logs within Zoho?

        Hello everyone, I’m currently refining our PMO setup within Zoho Projects and I’m curious how others are handling high-level governance documentation. We’ve been using the standardized Project Charter, Business Case and RAID frameworks from projectmanagertemplate.com
      • Is It Possible to Convert a Custom Module to a Quote?

        I recently created a custom module in our CRM environment for RFQs so that our sales team can submit quote requests directly in Zoho rather than by email/phone. This allows for a cleaner overall process, minimizing potential errors and potentially encouraging
      • 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
      • Closing the Loop: Why Lookup Asymmetry is Harming Data Integrity in Creator

        TL;DR: Lookup fields allow users to add new related records inline via the "+" icon, but there's no equivalent ability to edit an existing related record without navigating away and losing form context. Adding a native "Edit" icon—with automatic User
      • Next Page