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.