Zoho Sprints

App · Project Management · 20 actions

Agile project management. Plan and run sprints, and create, update and comment on work items in Scrum projects.

Actions

ActionWhat it does
Add work item commentAdd a comment to a work item.
Complete sprintComplete an active sprint.
Create projectCreate a Scrum project.
Create sprintCreate an upcoming sprint in a project.
Create work itemCreate a work item in a sprint or the project's backlog.
Delete projectDelete a project with its sprints and work items.
Delete sprintDelete a sprint.
Delete work itemDelete a work item.
Get projectGet a project's details, including its backlog and story-point scale.
Get sprintGet a sprint's details.
Get work itemGet a work item's details.
List projectsList the projects you are a member of in a workspace.
List sprintsList a project's sprints; upcoming and active ones by default.
List work item commentsList the comments on a work item.
List work itemsList the work items in a sprint or the project's backlog.
List workspacesList the Zoho Sprints workspaces you belong to, with their ids.
Start sprintStart an upcoming sprint.
Update projectRename a project or change its owner, group or dates.
Update sprintRename a sprint or change its description, dates or scrum master.
Update work itemChange a work item's name, type, priority, status, points, dates or assignees.

Add work item comment

Add a comment to a work item.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.
Work item IDitem_idtextRequired
The work item's id, from 'List work items' or 'Create work item'.
CommentcommenttextRequired
The comment.

Outputs

A comment on a work item.

created_bytext
The author's user id.
created_by_nametext
The author's name.
created_ontext
An ISO 8601 timestamp.
idtext
The comment's id.
reply_countnumber
How many replies it has.
texttext
The comment, as HTML.
updated_ontext
An ISO 8601 timestamp.
Example output
{
  "created_by": "2000000000005",
  "created_by_name": "Jane Doe",
  "created_on": "2026-10-02T11:00:00.000Z",
  "id": "2000000009101",
  "reply_count": 0,
  "text": "<div>Check this issue and fix it in this sprint</div>",
  "updated_on": "2026-10-02T11:00:00.000Z"
}

Complete sprint

Complete an active sprint. Every item in it must be closed or moved out first.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.
Sprint IDsprint_idtextRequired
The sprint's id, from 'List sprints' or 'Create sprint'.

Outputs

The sprint that was completed.

completedtrue/false
Always true.
completed_datetext
An ISO 8601 timestamp.
idtext
The sprint's id.
numbertext
The sprint's number.
Example output
{
  "completed": true,
  "completed_date": "2026-10-19T05:43:21.176Z",
  "id": "2000000008011",
  "number": "4"
}

Create project

Create a Scrum project. The free plan allows 3 projects.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
NamenametextRequired
The project's name.
Descriptiondescriptiontext
Optional. The description.
Ownerowner_idtext
Optional. The project's manager; blank makes the workspace admin the owner.
Project groupproject_group_idtext
Optional. The project group; blank keeps the default group.
Prefixprefixtext
Optional. Up to 3 characters put before item numbers.
Start datestart_datedate
Optional. The start date.
End dateend_datedate
Optional. The end date.

Outputs

A project.

backlog_idtext
The id of the project's backlog.
comment_countnumber
How many comments the project has.
created_bytext
The creator's user id.
created_timetext
An ISO 8601 timestamp.
descriptiontext
The project's description (details only).
end_datetext
An ISO 8601 timestamp.
estimation_pointslist
The project's story-point scale (Get project only), e.g. 0, 1, 2, 3, 5, 8.
group_idtext
The project group's id.
idtext
The project's id.
is_overduetrue/false
Whether the project is past its end date.
nametext
The project's name.
numbertext
The project's number in the workspace.
owner_idtext
The owner's user id.
owner_nametext
The owner's name.
prefixtext
The prefix of its item numbers, such as SP.
start_datetext
An ISO 8601 timestamp.
statustext
The project's status, such as ACTIVE.
typetext
The project's type, such as SCRUM.
Example output
{
  "backlog_id": "2000000006205",
  "comment_count": 0,
  "created_by": "2000000000005",
  "created_time": "2026-05-06T06:31:30.573Z",
  "description": null,
  "end_date": null,
  "group_id": "2000000000201",
  "id": "2000000006193",
  "is_overdue": false,
  "name": "Website relaunch",
  "number": "3",
  "owner_id": "2000000000005",
  "owner_name": "Jane Doe",
  "prefix": "WR",
  "start_date": null,
  "status": "ACTIVE",
  "type": "SCRUM"
}

Create sprint

Create an upcoming sprint in a project.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.
NamenametextRequired
The sprint's name.
Descriptiondescriptiontext
Optional. The description.
Start datestart_datedate
Optional. The start date.
End dateend_datedate
Optional. The end date.
Durationdurationtext
Optional. The planned length, such as 14d, 8h or 5d 12h.
Scrum masterscrum_master_idtext
Optional. The project member who runs the sprint.
Membersmember_idslist
Optional. The project members who will work on the sprint.

Outputs

The sprint just created.

end_datetext
The end sent to Zoho, if any.
idtext
The new sprint's id.
nametext
The sprint's name.
project_idtext
The project's id.
start_datetext
The start sent to Zoho, if any.
Example output
{
  "end_date": "2026-10-19T00:00:00+00:00",
  "id": "2000000008011",
  "name": "Sprint 4",
  "project_id": "2000000006193",
  "start_date": "2026-10-05T00:00:00+00:00"
}

Create work item

Create a work item in a sprint or the project's backlog.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.
NamenametextRequired
The work item's name.
Item typeitem_typetextRequired
The work item type, such as Task, Bug or Story.
Priorityprioritytext
Optional. The priority; blank means None.
Sprint IDsprint_idtext
Optional. The id of the sprint to add it to, from 'List sprints'. Leave blank for the project's backlog.
Statusstatustext
Optional. The status, such as To do, In progress or Done.
Descriptiondescriptiontext
Optional. The description.
Assigneesassignee_idslist
Optional. The project members who will work on it.
Story pointspointstext
Optional. Story points from the project's scale, such as 3 or 8.
Durationdurationtext
Optional. The planned length, such as 14d, 8h or 5d 12h.
Start datestart_datedate
Optional. The start date.
End dateend_datedate
Optional. The end date.

Outputs

The work item just created.

idtext
The new item's id.
nametext
The item's name.
numbertext
The item's number, such as I83.
project_idtext
The project's id.
sprint_idtext
The id of the sprint or backlog it was added to.
Example output
{
  "id": "2000000007994",
  "name": "Write the release notes",
  "number": "I83",
  "project_id": "2000000006193",
  "sprint_id": "2000000008011"
}

Delete project

Delete a project with its sprints and work items. This cannot be undone.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.

Outputs

The record that was deleted.

deletedtrue/false
Always true.
idtext
The record's id.
Example output
{
  "deleted": true,
  "id": "2000000006193"
}

Delete sprint

Delete a sprint. This cannot be undone.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.
Sprint IDsprint_idtextRequired
The sprint's id, from 'List sprints' or 'Create sprint'.

Outputs

The record that was deleted.

deletedtrue/false
Always true.
idtext
The record's id.
Example output
{
  "deleted": true,
  "id": "2000000008011"
}

Delete work item

Delete a work item. One with sub-items is refused.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.
Work item IDitem_idtextRequired
The work item's id, from 'List work items' or 'Create work item'.
Sprint IDsprint_idtext
Optional. The id of the sprint the work item is in, from 'List sprints'. Leave blank for the project's backlog.

Outputs

The record that was deleted.

deletedtrue/false
Always true.
idtext
The record's id.
Example output
{
  "deleted": true,
  "id": "2000000007994"
}

Get project

Get a project's details, including its backlog and story-point scale.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.

Outputs

A project.

backlog_idtext
The id of the project's backlog.
comment_countnumber
How many comments the project has.
created_bytext
The creator's user id.
created_timetext
An ISO 8601 timestamp.
descriptiontext
The project's description (details only).
end_datetext
An ISO 8601 timestamp.
estimation_pointslist
The project's story-point scale (Get project only), e.g. 0, 1, 2, 3, 5, 8.
group_idtext
The project group's id.
idtext
The project's id.
is_overduetrue/false
Whether the project is past its end date.
nametext
The project's name.
numbertext
The project's number in the workspace.
owner_idtext
The owner's user id.
owner_nametext
The owner's name.
prefixtext
The prefix of its item numbers, such as SP.
start_datetext
An ISO 8601 timestamp.
statustext
The project's status, such as ACTIVE.
typetext
The project's type, such as SCRUM.
Example output
{
  "backlog_id": "2000000006205",
  "comment_count": 0,
  "created_by": "2000000000005",
  "created_time": "2026-05-06T06:31:30.573Z",
  "description": null,
  "end_date": null,
  "estimation_points": [
    "0",
    "1",
    "2",
    "3",
    "5",
    "8",
    "13"
  ],
  "group_id": "2000000000201",
  "id": "2000000006193",
  "is_overdue": false,
  "name": "Website relaunch",
  "number": "3",
  "owner_id": "2000000000005",
  "owner_name": "Jane Doe",
  "prefix": "WR",
  "start_date": null,
  "status": "ACTIVE",
  "type": "SCRUM"
}

Get sprint

Get a sprint's details.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.
Sprint IDsprint_idtextRequired
The sprint's id, from 'List sprints' or 'Create sprint'.

Outputs

A sprint.

canceled_ontext
An ISO 8601 timestamp.
completed_ontext
An ISO 8601 timestamp.
created_bytext
The creator's user id.
created_timetext
An ISO 8601 timestamp.
descriptiontext
The sprint's description (details only).
durationtext
The sprint's length, such as 14d.
end_datetext
An ISO 8601 timestamp.
idtext
The sprint's id.
is_overduetrue/false
Whether the sprint is past its end date.
nametext
The sprint's name.
numbertext
The sprint's number in the project.
project_idtext
The project's id.
scrum_master_idtext
The scrum master's user id.
scrum_master_nametext
The scrum master's name.
start_datetext
An ISO 8601 timestamp.
started_ontext
An ISO 8601 timestamp.
statetext
Upcoming, Active, Completed or Canceled.
Example output
{
  "canceled_on": null,
  "completed_on": null,
  "created_by": "2000000000005",
  "created_time": "2026-10-01T09:00:00.000Z",
  "description": null,
  "duration": "14d",
  "end_date": "2026-10-19T00:00:00.000Z",
  "id": "2000000008011",
  "is_overdue": false,
  "name": "Sprint 4",
  "number": "4",
  "project_id": "2000000006193",
  "scrum_master_id": "2000000000005",
  "scrum_master_name": "Jane Doe",
  "start_date": "2026-10-05T00:00:00.000Z",
  "started_on": null,
  "state": "Upcoming"
}

Get work item

Get a work item's details.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.
Work item IDitem_idtextRequired
The work item's id, from 'List work items' or 'Create work item'.
Sprint IDsprint_idtext
Optional. The id of the sprint the work item is in, from 'List sprints'. Leave blank for the project's backlog.

Outputs

A work item.

assignee_idslist
The assignees' user ids.
assignee_nameslist
The assignees' names.
comment_countnumber
How many comments the item has.
completed_datetext
An ISO 8601 timestamp.
created_bytext
The creator's user id.
created_timetext
An ISO 8601 timestamp.
descriptiontext
The item's description (details only).
durationtext
The estimated duration, such as 8h.
end_datetext
An ISO 8601 timestamp.
idtext
The item's id.
is_overduetrue/false
Whether the item is past its end date.
item_type_idtext
The item type id.
nametext
The item's name.
numbertext
The item's number, such as I12.
parent_item_idtext
The parent item's id, for a sub-item.
pointstext
The index of its story points on the project's scale.
priority_idtext
The priority id.
project_idtext
The project's id.
sprint_idtext
The id of the sprint or backlog it is in.
start_datetext
An ISO 8601 timestamp.
status_idtext
The status id.
Example output
{
  "assignee_ids": [
    "2000000000005"
  ],
  "assignee_names": [
    "Jane Doe"
  ],
  "comment_count": 1,
  "completed_date": null,
  "created_by": "2000000000005",
  "created_time": "2026-10-02T10:00:00.000Z",
  "description": null,
  "duration": "8h",
  "end_date": null,
  "id": "2000000007994",
  "is_overdue": false,
  "item_type_id": "2000000006231",
  "name": "Write the release notes",
  "number": "I83",
  "parent_item_id": null,
  "points": "5",
  "priority_id": "2000000006227",
  "project_id": "2000000006193",
  "sprint_id": "2000000008011",
  "start_date": null,
  "status_id": "2000000005499"
}

List projects

List the projects you are a member of in a workspace.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Statusstatustext
Optional. Which projects; active ones by default.One of: 1 (Active), 2 (Archived), 6 (Templates). Default: 1.
Searchsearchtext
Optional. Only those whose name contains this text.
Limitlimitnumber
Optional. How many to return, up to 250.From 1 to 250. Default: 50.
Start atstart_indexnumber
Optional. Where the page starts: the next_index of the previous page.At least 1.

Outputs

countnumber
How many projects are on this page.
has_moretrue/false
Whether another page is available.
itemslist
The projects.
next_indexnumber
Pass as 'Start at' to fetch the next page; empty on the last.
Example output
{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "backlog_id": "2000000006205",
      "comment_count": 0,
      "created_by": "2000000000005",
      "created_time": "2026-05-06T06:31:30.573Z",
      "description": null,
      "end_date": null,
      "group_id": "2000000000201",
      "id": "2000000006193",
      "is_overdue": false,
      "name": "Website relaunch",
      "number": "3",
      "owner_id": "2000000000005",
      "owner_name": "Jane Doe",
      "prefix": "WR",
      "start_date": null,
      "status": "ACTIVE",
      "type": "SCRUM"
    }
  ],
  "next_index": null
}

List sprints

List a project's sprints; upcoming and active ones by default.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.
Statesstateslist
Optional. Which sprints; upcoming and active by default.One or more of: 1 (Upcoming), 2 (Active), 3 (Completed), 4 (Canceled).
Searchsearchtext
Optional. Only those whose name contains this text.
Limitlimitnumber
Optional. How many to return, up to 250.From 1 to 250. Default: 50.
Start atstart_indexnumber
Optional. Where the page starts: the next_index of the previous page.At least 1.

Outputs

countnumber
How many sprints are on this page.
has_moretrue/false
Whether another page is available.
itemslist
The sprints.
next_indexnumber
Pass as 'Start at' to fetch the next page; empty on the last.
Example output
{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "canceled_on": null,
      "completed_on": null,
      "created_by": "2000000000005",
      "created_time": "2026-10-01T09:00:00.000Z",
      "description": null,
      "duration": "14d",
      "end_date": "2026-10-19T00:00:00.000Z",
      "id": "2000000008011",
      "is_overdue": false,
      "name": "Sprint 4",
      "number": "4",
      "project_id": "2000000006193",
      "scrum_master_id": "2000000000005",
      "scrum_master_name": "Jane Doe",
      "start_date": "2026-10-05T00:00:00.000Z",
      "started_on": null,
      "state": "Upcoming"
    }
  ],
  "next_index": null
}

List work item comments

List the comments on a work item.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.
Work item IDitem_idtextRequired
The work item's id, from 'List work items' or 'Create work item'.
Limitlimitnumber
Optional. How many to return, up to 250.From 1 to 250. Default: 50.
Start atstart_indexnumber
Optional. Where the page starts: the next_index of the previous page.At least 1.

Outputs

countnumber
How many comments are on this page.
has_moretrue/false
Whether another page is available.
itemslist
The comments.
next_indexnumber
Pass as 'Start at' to fetch the next page; empty on the last.
Example output
{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "created_by": "2000000000005",
      "created_by_name": "Jane Doe",
      "created_on": "2026-10-02T11:00:00.000Z",
      "id": "2000000009101",
      "reply_count": 0,
      "text": "<div>Check this issue and fix it in this sprint</div>",
      "updated_on": "2026-10-02T11:00:00.000Z"
    }
  ],
  "next_index": null
}

List work items

List the work items in a sprint or the project's backlog.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.
Sprint IDsprint_idtext
Optional. The id of the sprint the work item is in, from 'List sprints'. Leave blank for the project's backlog.
Statusstatus_typeslist
Optional. Only open, in-progress or closed items.One or more of: 0 (Open), 2 (In progress), 1 (Closed).
Assigneesassignee_idslist
Optional. Only items assigned to these project members.
Search bysearch_bytext
Optional. What 'Search' matches; the name by default.One of: name, id (Item number). Default: name.
Searchsearchtext
Optional. Text to look for in the name or item number.
Include sub-itemsinclude_subitemstrue/false
Optional. Also list sub-items.Default: false.
Limitlimitnumber
Optional. How many to return, up to 250.From 1 to 250. Default: 50.
Start atstart_indexnumber
Optional. Where the page starts: the next_index of the previous page.At least 1.

Outputs

countnumber
How many work items are on this page.
has_moretrue/false
Whether another page is available.
itemslist
The work items.
next_indexnumber
Pass as 'Start at' to fetch the next page; empty on the last.
Example output
{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "assignee_ids": [
        "2000000000005"
      ],
      "assignee_names": [
        "Jane Doe"
      ],
      "comment_count": 1,
      "completed_date": null,
      "created_by": "2000000000005",
      "created_time": "2026-10-02T10:00:00.000Z",
      "description": null,
      "duration": "8h",
      "end_date": null,
      "id": "2000000007994",
      "is_overdue": false,
      "item_type_id": "2000000006231",
      "name": "Write the release notes",
      "number": "I83",
      "parent_item_id": null,
      "points": "5",
      "priority_id": "2000000006227",
      "project_id": "2000000006193",
      "sprint_id": "2000000008011",
      "start_date": null,
      "status_id": "2000000005499"
    }
  ],
  "next_index": null
}

List workspaces

List the Zoho Sprints workspaces you belong to, with their ids.

Inputs

None.

Outputs

countnumber
How many workspaces the user belongs to.
default_workspace_idtext
The user's default workspace id.
itemslist
The workspaces.
Example output
{
  "count": 1,
  "default_workspace_id": "60012345",
  "items": [
    {
      "id": "60012345",
      "is_default": true,
      "name": "Acme",
      "org_name": "Acme"
    }
  ]
}

Start sprint

Start an upcoming sprint. The free plan runs one sprint at a time.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.
Sprint IDsprint_idtextRequired
The sprint's id, from 'List sprints' or 'Create sprint'.

Outputs

The sprint that was started.

idtext
The sprint's id.
numbertext
The sprint's number.
startedtrue/false
Always true.
Example output
{
  "id": "2000000008011",
  "number": "4",
  "started": true
}

Update project

Rename a project or change its owner, group or dates.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.
Namenametext
Optional. A new name.
Ownerowner_idtext
Optional. A new owner from the project's members.
Project groupproject_group_idtext
Optional. The project group; blank keeps the default group.
Start datestart_datedate
Optional. The start date.
End dateend_datedate
Optional. The end date.

Outputs

The record that was changed.

fieldslist
The Zoho fields that were sent.
idtext
The record's id.
updatedtrue/false
Always true.
Example output
{
  "fields": [
    "name"
  ],
  "id": "2000000006193",
  "updated": true
}

Update sprint

Rename a sprint or change its description, dates or scrum master.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.
Sprint IDsprint_idtextRequired
The sprint's id, from 'List sprints' or 'Create sprint'.
Namenametext
Optional. A new name.
Descriptiondescriptiontext
Optional. The description.
Start datestart_datedate
Optional. The start date.
End dateend_datedate
Optional. The end date.
Durationdurationtext
Optional. The planned length, such as 14d, 8h or 5d 12h.
Scrum masterscrum_master_idtext
Optional. The project member who runs the sprint.

Outputs

The record that was changed.

fieldslist
The Zoho fields that were sent.
idtext
The record's id.
updatedtrue/false
Always true.
Example output
{
  "fields": [
    "name"
  ],
  "id": "2000000008011",
  "updated": true
}

Update work item

Change a work item's name, type, priority, status, points, dates or assignees.

Inputs

Workspaceworkspace_idtextRequired
The Zoho Sprints workspace.
Projectproject_idtextRequired
The project: pick one, or paste an id from 'List projects'.
Work item IDitem_idtextRequired
The work item's id, from 'List work items' or 'Create work item'.
Sprint IDsprint_idtext
Optional. The id of the sprint the work item is in, from 'List sprints'. Leave blank for the project's backlog.
Namenametext
Optional. A new name.
Item typeitem_typetext
Optional. A new work item type, such as Task, Bug or Story.
Priorityprioritytext
Optional. The priority, such as Low, Medium or High.
Statusstatustext
Optional. The status, such as To do, In progress or Done.
Descriptiondescriptiontext
Optional. The description.
Story pointspointstext
Optional. Story points from the project's scale, such as 3 or 8.
Start datestart_datedate
Optional. The start date.
End dateend_datedate
Optional. The end date.
Add assigneesadd_assignee_idslist
Optional. Project members to assign.
Remove assigneesremove_assignee_idslist
Optional. Assignees to take off the item.

Outputs

The record that was changed.

fieldslist
The Zoho fields that were sent.
idtext
The record's id.
updatedtrue/false
Always true.
Example output
{
  "fields": [
    "statusid"
  ],
  "id": "2000000007994",
  "updated": true
}

On this page