SprintsSettings

Last modified: 19 March 2025

Describes sprints configuration.

Attributes

This table describes attributes of the SprintsSettings entity.

  • To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

id

String

The ID of the sprints configuration. Read-only.

isExplicit

Boolean

If true, issues should be added to the board manually. If false, issues are shown on the board based on the query and/or value of a field.

cardOnSeveralSprints

Boolean

If true, cards can be present on several sprints of this board.

defaultSprint

Sprint

New cards are added to this sprint by default. This setting applies only if isExplicit == true. Can be null.

disableSprints

Boolean

If true, agile board has no distinct sprints in UI. However, in API it will look like it has only one active (not-archived) sprint.

explicitQuery

String

Issues that match this query will appear on the board. This setting applies only if isExplicit == false. Can be null.

sprintSyncField

CustomField

Based on the value of this field, issues will be assigned to the sprints. This setting applies only if isExplicit == false. Can be null.

hideSubtasksOfCards

Boolean

If true, subtasks of the cards, that are present on the board, will be hidden if they match board query. This setting applies only if isExplicit == false.