Sprints in Scrum: Overview of Methods

A sprint is a short iterative cycle during which a team accomplishes specific work. This format allows for obtaining a small but predictable result within a clear timeframe.

Quick navigation: all methods and events

User documentation: Bitrix24.Scrum

Connection of Sprints with Other ObjectsConnection of Sprints with Other Objects

Workgroup. Sprints are linked to a workgroup (scrum) by the group identifier groupId. You can obtain the identifier using the create new group method or the get list of groups method. A group is considered a scrum if the SCRUM_MASTER_ID field is filled.

How to Start a SprintHow to Start a Sprint

The method tasks.api.scrum.sprint.start starts a sprint by the sprint identifier id. You can obtain the sprint identifier using the create new sprint method or the get list of sprints method. You can only start a planned sprint, meaning one with the status planned. The status of a started sprint will change to active.

How to Complete an Active SprintHow to Complete an Active Sprint

The method tasks.api.scrum.sprint.complete completes an active sprint by the group identifier id, not the sprint. You can obtain the identifier using the create new group method or the get list of groups method. The status of a completed sprint will change from active to completed.

Overview of MethodsOverview of Methods

Scope: task

Who can execute the method: depending on the method

Method	Description
tasks.api.scrum.sprint.add	Adds a sprint to Scrum
tasks.api.scrum.sprint.update	Updates a sprint
tasks.api.scrum.sprint.start	Starts a sprint
tasks.api.scrum.sprint.complete	Completes an active sprint of the selected Scrum
tasks.api.scrum.sprint.get	Retrieves the field values of a sprint by its id
tasks.api.scrum.sprint.list	Retrieves a list of sprints
tasks.api.scrum.sprint.delete	Deletes a sprint
tasks.api.scrum.sprint.getFields	Retrieves available fields of a sprint