Get Entity IDs for API requests | API Guide | Zoho Sprints Help

Get Entity IDs for API requests

Developers often look for entity IDs, field IDs, module IDs to use in their API calls to avoid ambiguity and make API requests reliable and maintainable.

In Zoho Sprints, we provide the option to copy the ID or URL of an entity, which can be used directly in the API requests.

Get Team ID 

  1. Navigate to the Settings page. 
  2. In the workspace details section, copy the ID available under Workspace ID.  

Get Project System ID/ Project URL

  1. Navigate to a project.
  2. Hover over the project name and click View Details.
  3. On the Project details page, hover over the Project ID.
  4. Select Copy Project System ID (or) Copy Project URL

Get Item System ID/ Item ID/ Item URL/ ID with prefix

  1. Navigate to a project.
  2. Select an item.
  3. On the Item details page, hover over the project name prefix.
  4. Select Copy Item System ID (or) Item ID (or) Copy Item URL (or) Copy ID with prefix

Get Sprint System ID/ Sprint ID/ Sprint URL

  1. Navigate to a project.
  2. Click on the sprint and open the Sprint details page.
  3. On the Sprint details page, hover over the Sprint ID.
  4. Select Copy Sprint System ID (or) Sprint ID (or) Copy Sprint URL. 


Get Release System ID/ Release ID/ Release URL

  1. Navigate to a project.
  2. Go to the Release module.
  3. On the Release details page, hover over the Release ID.
  4. Select Copy Release System ID (or) Release ID (or) Copy Release URL

Get Epic System ID/ Epic ID/ Epic URL 

  1. Access Zoho Sprints workspace.
  2. Navigate to a project. 
  3. Go to the Epics module. 
  4. Hover over an epic and click the Details button. 
  5. On the Epic details page, hover over the epic prefix. 
  6. Select Copy Epic System ID or Copy Epic ID or Copy Epic URL



Get Log Hour System ID/ Details URL 

  1. Access Zoho Sprints workspace.
  2. Navigate to a project. 
  3. Open the Timesheet module. 
  4. Click and open a log hour. 
  5. On the log hour details page, hover over the log hour prefix. 
  6. Click Copy Log Hour System ID or Copy Details URL.

Get Meeting ID/ Details URL 

  1. Access Zoho Sprints workspace.
  2. Navigate to a project. 
  3. Open the Meeting module. 
  4. Click and open a meeting. 
  5. On the Meetings details page, hover over the meeting prefix. 
  6. Select Copy Meeting ID or Copy Details URL

Get User System ID/ Details URL

  1. Access Zoho Sprints workspace.
  2. Navigate to settings. 
  3. Select Workspace Users under Manage Users
  4. Click and open a user profile. 
  5. On the User details page, hover over the user prefix. 
  6. Select Copy User System ID or Copy Details URL

Get Objective URL 

  1. Access Zoho Sprints workspace.
  2. Select OKRs under Global Modules.
  3. Click and open an objective.
  4. On the Objective details page, hover over the objective prefix.
  5. Select Copy URL

Get Key Result URL

  1. Access Zoho Sprints workspace.
  2. Select OKRs under Global Modules.
  3. Click and open a key result.
  4. On the Key Results details page, hover over the key result prefix.
  5. Select Copy URL

Get Custom Module record ID/ URL / System ID

  1. Access Zoho Sprints workspace.
  2. Select the respective custom module.
  3. Click and open a record.
  4. On the record details page, hover over the record prefix.
  5. Select Copy System ID (or) Copy ID (or) Copy URL

Get Param Name of fields

  1. Access Zoho Sprints workspace.
  2. Navigate to setup.
  3. Click Available Fields under Customization.
  4. Select the required module.
    List of all fields used in the module will be displayed here.
  5. Click the Other actions icon beside the respective field name.
  6. Select Copy Param Name

Idea
For example, when you copy a param name, the copied field name starts with 'UDF_' followed by type of the field. Value of a single line field may look like 'UDF_CHAR{1}'.

Get Backlog ID

  1. Access Zoho Sprints workspace.
  2. Select a project.
  3. Click on the Backlog header.
  4. On the backlog details page, hover over the backlog ID.
  5. Select Copy Backlog ID.

Get Kanban Board ID

  1. Access Zoho Sprints workspace.
  2. Select a Kanban project.
  3. Click the View board details button beside the Kanban Board header.
  4. On the board details page, hover over the board ID.
  5. Select Copy Kanban Board ID



        Create. Review. Publish.

        Write, edit, collaborate on, and publish documents to different content management platforms.

        Get Started Now


          Access your files securely from anywhere

            Zoho CRM Training Programs

            Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

            Zoho CRM Training
              Redefine the way you work
              with Zoho Workplace

                Zoho DataPrep Personalized Demo

                If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

                Zoho CRM Training

                  Create, share, and deliver

                  beautiful slides from anywhere.

                  Get Started Now


                    Zoho Sign now offers specialized one-on-one training for both administrators and developers.

                    BOOK A SESSION







                                Quick LinksWorkflow AutomationData Collection
                                Web FormsEnterpriseOnline Data Collection Tool
                                Embeddable FormsBankingBegin Data Collection
                                Interactive FormsWorkplaceData Collection App
                                CRM FormsCustomer ServiceAccessible Forms
                                Digital FormsMarketingForms for Small Business
                                HTML FormsEducationForms for Enterprise
                                Contact FormsE-commerceForms for any business
                                Lead Generation FormsHealthcareForms for Startups
                                Wordpress FormsCustomer onboardingForms for Small Business
                                No Code FormsConstructionRSVP tool for holidays
                                Free FormsTravelFeatures for Order Forms
                                Prefill FormsNon-Profit

                                Intake FormsLegal
                                Mobile App
                                Form DesignerHR
                                Mobile Forms
                                Card FormsFoodOffline Forms
                                Assign FormsPhotographyMobile Forms Features
                                Translate FormsReal EstateKiosk in Mobile Forms
                                Electronic Forms
                                Drag & drop form builder

                                Notification Emails for FormsAlternativesSecurity & Compliance
                                Holiday FormsGoogle Forms alternative GDPR
                                Form to PDFJotform alternativeHIPAA Forms
                                Email FormsFormstack alternativeEncrypted Forms

                                Wufoo alternativeSecure Forms

                                TypeformWCAG


                                    All-in-one knowledge management and training platform for your employees and customers.

                                              Create. Review. Publish.

                                              Write, edit, collaborate on, and publish documents to different content management platforms.

                                              Get Started Now




                                                                You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                                    Manage your brands on social media


                                                                      • Desk Community Learning Series


                                                                      • Digest


                                                                      • Functions


                                                                      • Meetups


                                                                      • Kbase


                                                                      • Resources


                                                                      • Glossary


                                                                      • Desk Marketplace


                                                                      • MVP Corner


                                                                      • Word of the Day


                                                                      • Ask the Experts


                                                                        Zoho Sheet Resources

                                                                         

                                                                            Zoho Forms Resources


                                                                              Secure your business
                                                                              communication with Zoho Mail


                                                                              Mail on the move with
                                                                              Zoho Mail mobile application

                                                                                Stay on top of your schedule
                                                                                at all times


                                                                                Carry your calendar with you
                                                                                Anytime, anywhere




                                                                                      Zoho Sign Resources

                                                                                        Sign, Paperless!

                                                                                        Sign and send business documents on the go!

                                                                                        Get Started Now




                                                                                                Zoho TeamInbox Resources





                                                                                                          Zoho DataPrep Demo

                                                                                                          Get a personalized demo or POC

                                                                                                          REGISTER NOW


                                                                                                            Design. Discuss. Deliver.

                                                                                                            Create visually engaging stories with Zoho Show.

                                                                                                            Get Started Now








                                                                                                                                • Related Articles

                                                                                                                                • Introduction to Zoho Sprints API

                                                                                                                                  Zoho Sprints APIs use Oauth 2.0 framework for authorization and authentication. They are REST based and will help you manage your data in Sprints with ease. You will be able to integrate with other Zoho applications and third-party applications using ...
                                                                                                                                • Zoho Sprints Quickstart Guide

                                                                                                                                  Zoho Sprints is a project management tool built on Agile principles. It supports both Scrum and Kanban frameworks to help teams plan, track, and deliver work efficiently. In Scrum projects, work is organized into time-boxed iterations (sprints), ...
                                                                                                                                • About release

                                                                                                                                  Release is an integral agile approach that facilitates your product to reach your customers periodically with something new and enhanced. It is founded on the principle of continuous and incremental development. This allows you to frequently churn ...
                                                                                                                                • About webhooks

                                                                                                                                  A webhook is a HTTP callback or push API that automatically sends real time notifications to third party applications. These notifications are sent when you perform a set of events. Before you start, you need to know the following: To start using a ...
                                                                                                                                • Configure and use AI tools

                                                                                                                                  Zoho Sprints leverages generative AI to smoothen out and elevate the nuanced areas of project management, facilitating ease and speed. It provides the vital assistance that is required to articulate ideas with clarity, generate crisp and clear ...
                                                                                                                                  Wherever you are is as good as
                                                                                                                                  your workplace

                                                                                                                                    Resources

                                                                                                                                    Videos

                                                                                                                                    Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                                    eBooks

                                                                                                                                    Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                                    Webinars

                                                                                                                                    Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                                    CRM Tips

                                                                                                                                    Make the most of Zoho CRM with these useful tips.



                                                                                                                                      Zoho Show Resources