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.
Blueprints
Create, update, delete, and execute task blueprints.
Attachments
Retrieve, upload, associate, and disassociate project attachments.
Leaves
Retrieve, add, update, and delete leave records.
Profiles
Manage portal profiles, permissions, and default profile settings.
Roles
Create, update, delete, and assign default user roles.
Clients
Manage client details, project associations, and updates.
Module Meta
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

    • 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

    • Recent Topics

    • E-Invoicing Automation

      Do you have an API endpoint for pushing the invoice through the e-tims for Kenya

    • Easy way to create task from call

      In Bigin I would like to have easy way of creating the tast directly from the call. Now after the call I need to enter company record and create task there. There must be some easier and more user friendly way to create new task after the call!

    • Can we have Backorder Management ?

      Can we have Backorder Management ?

    • 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

    • Performance -> Extend Service -> Forms: How to use created form?

      So I have created a new Annual Evaluation form (cloned from the original one) and now I want to use it in an Appaisal cycle. QUESTION: How can I associate the form with the new Appraisal Template? Also, what is the difference between an Appraiser and

    • Ask the Experts 19: Live Expert Panel Discussion - Inside Zoho Desk Spring Release 2025

      Hello again! Have you ever needed quick insights into key indicators to help manage and streamline specific operations? Have you started using AI to enhance your customer service in Zoho Desk? From configuring simple bots using Guided Conversations to

    • 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

    • Assessments score?

      So, from what I was able to find when you make a pre-screening assessment with questions and answer that have points value. You have no way to quickly sort the applicant by value without having to go inside each application and open the assessment to

    • Magento 2 as data source for Analytics

      I see that Shopify is in Beta as a data source, any change that Magento 2 is in the works? We currently use Metrilo to parse our eCommerce data for marketing and would love to keep that inside our Zoho ecosystem. Thank you!

    • 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

    • m2 is converted to Kader when switching from Dutch to English

      By default, our company works in Dutch. We sell a lot of products with m2 as a unit. Now we've noticed that if we change the language in Zoho to English, the usage unit 'm2' gets replaced by 'Kader'. We've got no idea why. I'd expect that the translation

    • Adding string / text fields to modules

      I'm working on a custom leads module with a layout for call center agents.  I need to add text fields that are for display purposes only to prompt call center agents.  I haven't found any way to add a field in Zoho CRM that doesn't accept input, ie. is

    • Avalara Integration To Simplify Tax Calculations

      We are delighted to inform you that Zoho FSM now allows integration with Zoho Books accounts that have Avalara integration enabled in them. Designed for businesses operating across different regions and jurisdictions, Avalara ensures tax accuracy by factoring

    • Restrict card movement in Kanban View

      Hello everyone, I’m wondering if there’s a way to prevent users from moving Deal cards in the Kanban view when grouped by Stage. On the Deal details page, I’ve implemented several validations to ensure users cannot change stages until all conditions,

    • Zoho Payroll's USA and KSA editions are available in Zoho One!

      Greetings! We’re excited to share that Zoho Payroll, currently available only in India and the UAE, is now introducing the KSA (Kingdom of Saudi Arabia) edition and the USA (United States of America) edition, and these editions are now available in Zoho

    • How to handle multiple languages (Resume parser, Job opening, job board, career site) ?

      We are looking to bring Zoho Recruit to a market that needs to support 2 languages. The first thing we need to make sure is that the Candidate be flag with the language they speak. This is easy enough make a custom field that as the desire languages.

    • Zoho Sign & Analytics

      Hi, Is it possible to import data from Sign into Analytics?

    • adding attachment in sendmail script where attachment is in a CRM field

      Hi all, I have a custom field of type 'File Upload' in one of my modules in my CRM. I want to include the file in that field as an attachment to an email - which is done from a button on  the 'Results' module. I have created a script and a button to initiate an email from that module. The Deluge scripting window has allowed me to add arguments for all the fields I need to use except for the one file upload type field. My script currently looks like the below (content of the email omitted). As you

    • How to unvoid sales order ?

      Helo, We need to make a credit not from a voided invoice, which is linked to a voided sale order. I can't find a way to unvoid a sale order. There only a way to convert it to a Purchase order instead... The invoice can't be send back to draft because of the voided sale order. From a accountancy point of view, and treacability, we can't make a standalone credit note. What is the usual procedure? Thanks

    • Currency Field Does Not show commas upon entry - leading to inaccurate entries!

      Hello Zoho.. When our sales reps are entering deals and the profit/revenue it is difficult to accurately enter numbers with lots of zeros when there commas are NOT added until the record is saved. Could commas be added to this filed type as it is being

    • Zoho Assist not rendering NinjaTrader chart properly

      Hi everyone. Just installed and testing Zoho Assist. I want to display my laptop' screen (Windows 11) on a monitor connected to my Mac mini. The laptop is running a stock trading program called NinjaTrader. Basically, when running, this program displays

    • CRM->INVENTORY, sync products as composite items

      We have a product team working in the CRM, as it’s more convenient than using Books or Inventory—especially with features like Blueprints being available. Once a product reaches a certain stage, it needs to become visible in Inventory. To achieve this,

    • Introducing Assemblies and Kits in Zoho Inventory

      Hello customers, We’re excited to share a major revamp to Zoho Inventory that brings both clarity and flexibility to your inventory management experience! Presenting Assemblies and Kits We’re thrilled to introduce Assemblies and Kits, which replaces the

    • openUrl in blueprints

      My customer wants to open a URL at the end of a blueprint transition. Seems this isn't possible right now but it would be very useful. In this thread, https://help.zoho.com/portal/en/community/topic/openurl-not-working the Zoho agent said that it's logically

    • 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

    • Transfer image url from Zoho Forms to Zoho Analytics

      I am storing an image in a zoho form. When I pull the data from the form into zoho analytics the image field does not import. How do I pull in the image url location or the image into Zoho Analytics.

    • Why ZOHO Function Can't Read Custom Field API In Quotes Module (Subform)

      I’m using a Deluge function to transfer data from a subform in the Quotes module to a subform in the Accounts module. Everything works except for a custom picklist field in Quotes—no matter what I try, the Zoho API can’t read that field ("Status_sb").

    • Modules are continuously loading

      Hi! We are not able to open the task modules, it keeps continuously loading

    • Introducing Image Upload Field

      Hello everyone, In this post we will discuss about the benefits and usage of the Image upload field. The field is available for standard and custom modules.  Usage: This field can be used to upload a gallery of images to a record and share the record with peers or customers. The record can be made accessible to users outside of Zoho CRM via Portals, where they can upload the necessary images. Preview, editing, and deleting images: The uploaded images can be directly edited and saved from the record

    • Create multiple leads from a zoho form subform to populate inside zoho crm lead module

      I have corporate clients with numerous employees. When these clients complete our Zoho Form, they can nominate individual employees—providing details like first name, last name, email, mobile number, etc.—using a subform inside the zoho form. Is it possible

    • BCC Dropbox on the Agency Module

      Good morning! We've recently implemented the BCC Dropbox feature on our Zoho CRM, but this only appears to be working on the Leads and Contractor (Contacts) modules. It would be incredibly useful for it to work on our Agency module too as a way of tracking

    • Unable to Retrieve refresh_token from Zoho Self-Client OAuth Flow

      Hello Zoho Support Team, I am currently integrating Zoho CRM with a custom Node.js backend using the Zoho OAuth 2.0 authorization process. I created a Self-Client from the Zoho API Console and generated an authorization code successfully. However, when

    • On create of Amc module get sub form data of last row and update in Schedule Vist End Date field in zoho crm

      @Iswarya B G @Bhoomi Joshi @Abinaya Praveen @Ishwarya SG @Haiku Technical Support On create of Amc module get sub form data of last row and update in normal module field Schedule Vist End Date field in zoho crm

    • Tip: when "\r\n" not working for new-lines when building a file using the .toFile() function

      As above, ran into an issue - "\n" was working for newlines, but "\r\n" was not working for newlines and carriage returns. Took me a bit but using hexToText("0D0A") in place of "\r\n" resolved this. Including in the forums to save others any drama.

    • 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

    • Multiple Pipelines

      Is it possible to create multiple candidate pipelines?

    • Showing meeting acceptances in CRM that originated from Outlook

      Hello Zoho Team, We send meeting invitations from Zoho CRM. Many of our recipients use Outlook and therefore use the RSVP buttons from Outlook to respond. They rarely, if ever, use the RSVP buttons from the Zoho invitation. Unfortunately, the meeting

    • Weekly Tips: Folder Sharing Simplified with Zoho Mail

      Let's say your team is working on a project that requires gathering numerous inputs via email. Your team lead, who manages the project, receives a flood of emails containing critical information. Instead of forwarding each email individually—which can

    • How to add a customized/dynamic Zoho Booking link in email footer?

      We just installed the latest version of the Zoho Desk <=> Zoho Booking extension from the marketplace and are quite happy to see the feature where a ticket-specific appointment booking link can be inserted in a reply. Is there any way to configure this

    • ZOHO BOOKS EXPERT

      We are planning to migrate from Quick Books to Zoho Books, and are looking for a professional with experience in migration to Zoho Books and the setup of Zoho Books. Currently, we have two companies and two Quick Books accounts, and we want to integrate

    • Next Page