Agile

Last modified: 11 March 2025

Represents an agile board configuration.

Related Resources

Below you can find the list of resources that let you work with this entity.

Attributes

This table describes attributes of the Agile 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 agile board. Read-only.

name

String

The name of the agile board. Can be null.

owner

User

The owner of the agile board. Can be null.

visibleFor

UserGroup

Deprecated. Use the readSharingSettings attribute instead.

The group of users that can view this board.

Can be null.

visibleForProjectBased

Boolean

Deprecated.

When true, the board is visible to anyone who can view all projects that are associated with the board.

updateableBy

UserGroup

Deprecated. Use the updateSharingSettings attribute instead.

The group of users who can update the settings of this board.

Can be null.

updateableByProjectBased

Boolean

Deprecated.

When true, anyone who can update the associated projects can update the board.

readSharingSettings

AgileSharingSettings

Users and groups that can view this board. If the board is visible only to its owner, this property contains an empty array. Read-only.

updateSharingSettings

AgileSharingSettings

Users and groups that can update this watch folder. If only the folder's owner can update it, this property contains an empty array. Read-only.

orphansAtTheTop

Boolean

When true, the orphan swimlane is placed at the top of the board. Otherwise, the orphans swimlane is located below all other swimlanes.

hideOrphansSwimlane

Boolean

When true, the orphans swimlane is not displayed on the board.

estimationField

CustomField

A custom field that is used as the estimation field for the board. Can be null.

originalEstimationField

CustomField

A custom field that is used as the original estimation field for the board. Can be null.

projects

Array of Projects

A collection of projects associated with the board.

sprints

Array of Sprints

The set of sprints that are associated with the board.

currentSprint

Sprint

A sprint that is designated as the current one for this agile board. Read-only. Can be null.

columnSettings

ColumnSettings

Column settings of the board. Read-only.

swimlaneSettings

SwimlaneSettings

Settings of the board swimlanes. Can be null.

sprintsSettings

SprintsSettings

Settings of the board sprints. Read-only.

colorCoding

ColorCoding

Color coding settings for the board. Can be null.

status

AgileStatus

Status of the board. Read-only.