---
schema: rendered-html/v1
title: "Agile | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/api-entity-Agile.html
generated_at: 2026-06-11T14:44:46.201331+00:00
---

Feedback

Thanks for your feedback!

Was this page helpful?

YesNo

Developer Portal for YouTrack and Hub

- Developer Portal
- Apps
- MCP Tools
- YouTrack Workflows
- YouTrack Import Scripts
- YouTrack Form API
- YouTrack REST API
- Get Started with REST API
- REST API Reference
- Entities
- AccessScope
- [ActivityCategory](jetbrains__com__help__youtrack__devportal__api-entity-activitycategory.md)
- [ActivityCursorPage](jetbrains__com__help__youtrack__devportal__api-entity-activitycursorpage.md)
- [ActivityItem](jetbrains__com__help__youtrack__devportal__api-entity-activityitem.md)
- [Agile](api-entity-Agile.html)
- [AgileColumn](jetbrains__com__help__youtrack__devportal__api-entity-agilecolumn.md)
- [AgileSharingSettings](jetbrains__com__help__youtrack__devportal__api-entity-agilesharingsettings.md)
- [AgileStatus](jetbrains__com__help__youtrack__devportal__api-entity-agilestatus.md)
- [AppearanceSettings](jetbrains__com__help__youtrack__devportal__api-entity-appearancesettings.md)
- [ArticleAttachment](jetbrains__com__help__youtrack__devportal__api-entity-articleattachment.md)
- ArticleComment
- AssignedRole
- BackupError
- BackupFile
- BackupStatus
- BaseArticle
- BaseWorkItem
- Bundle
- BundleElement
- ChangesProcessor
- ColorCoding
- ColumnSettings
- CommandList
- CommandVisibility
- CustomField
- CustomFieldCondition
- CustomFieldDefaults
- DatabaseAttributeValue
- DatabaseBackupSettings
- DateFormatDescriptor
- DuplicateVote
- DurationValue
- EmailSettings
- Event
- ExternalArticle
- ExternalIssue
- FieldStyle
- FieldType
- FilterField
- GeneralUserProfile
- GlobalSettings
- GlobalTimeTrackingSettings
- Issue
- IssueAttachment
- IssueComment
- IssueCountResponse
- IssueCustomField
- IssueFolder
- IssueKey
- IssueLink
- IssueLinkType
- IssueTimeTracking
- IssueVoters
- IssueWatcher
- IssueWatchers
- License
- LocaleDescriptor
- LocaleSettings
- Logo
- NotificationSettings
- NotificationsUserProfile
- OnlineUsers
- Organization
- ParsedCommand
- PeriodFieldFormat
- PeriodValue
- Permission
- ProjectColor
- ProjectCustomField
- ProjectTimeTrackingSettings
- PullRequest
- PullRequestChange
- PullRequestState
- Reaction
- RestCorsSettings
- Role
- SearchSuggestions
- Sprint
- SprintsSettings
- StorageEntry
- Suggestion
- SwimlaneSettings
- SwimlaneValue
- SystemSettings
- TagSharingSettings
- Telemetry
- TextFieldValue
- TimeTrackingUserProfile
- TimeZoneDescriptor
- User
- UserGroup
- UserProfiles
- UserType
- VcsChange
- VcsServer
- Visibility
- WIPLimit
- WatchFolderSharingSettings
- WorkItemAttribute
- WorkItemAttributePrototype
- WorkItemAttributeValue
- WorkItemProjectAttribute
- WorkItemType
- WorkTimeSettings
- Resources
- REST API Use Cases
- REST API Troubleshooting
- Color Indices List
- Hub REST API

1. YouTrack REST API
2. REST API Reference
3. Entities
4. [Agile](#0)

# Agile﻿

Last modified: 24 March 2025

Represents an agile board configuration.

## Related Resources﻿

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

- Agile Boards

## 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. |
| 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](jetbrains__com__help__youtrack__devportal__api-entity-agilesharingsettings.md) | 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](jetbrains__com__help__youtrack__devportal__api-entity-agilesharingsettings.md) | 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](jetbrains__com__help__youtrack__devportal__api-entity-agilestatus.md) | Status of the board. `Read-only`. |

- [Agile](/help/youtrack/devportal/api-entity-Agile.html)
- [Related Resources](/help/youtrack/devportal/api-entity-Agile.html#-j8vfhe_3)
- [Attributes](/help/youtrack/devportal/api-entity-Agile.html#-j8vfhe_4)

WorkItemDurationActivityItem[AgileColumn](jetbrains__com__help__youtrack__devportal__api-entity-agilecolumn.md)

- Privacy & Security
- Terms Of Use
- Trademarks
- Legal

Copyright © 2000–2026 JetBrains s.r.o.

![](https://bat.bing.com/action/0?ti=5220035&tm=gtm002&Ver=2&mid=15358f5b-1e6c-4f05-99ce-98ad8ad8b33e&bo=4&sid=452929b065a111f19a7fe7356f74a419&vid=aa3122f0648711f1a10d6d095e10fd87&vids=0&msclkid=N&pi=918639831&lg=en-US&sw=1920&sh=1080&sc=24&tl=Agile%20%7C%20Developer%20Portal%20for%20YouTrack%20and%20Hub%20Documentation&p=https%3A%2F%2Fwww.jetbrains.com%2Fhelp%2Fyoutrack%2Fdevportal%2Fapi-entity-Agile.html&r=&lt=694&pt=1781189083523,105,105,,,5,5,5,5,5,,5,80,80,110,291,291,291,692,694,694&pn=0,0&evt=pageLoad&sv=2&asc=G&cdb=AQAS&rn=224526)

![](https://crawler.prototype.prolicht.digital/l/QCRzy0)![](https://crawler.prototype.prolicht.digital/l/R7EXwy)
