Columns - List
Get columns on a board
GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/columns?api-version=5.1
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
board
|
path | True |
string |
Name or ID of the specific board |
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
project
|
path | True |
string |
Project ID or project name |
team
|
path |
string |
Team ID or team name |
|
api-version
|
query | True |
string |
Version of the API to use. This should be set to '5.1' to use this version of the api. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
successful operation |
Security
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
Name | Description |
---|---|
vso.work | Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks. |
Examples
Get board columns by board |
Get board columns by board |
Get board columns by boardId
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam/Fabrikam Team/_apis/work/boards/{board}/columns?api-version=5.1
Sample Response
{
"count": 4,
"value": [
{
"id": "12eed5fb-8af3-47bb-9d2a-058fbe7e1196",
"name": "New",
"itemLimit": 0,
"stateMappings": {
"Product Backlog Item": "New",
"Bug": "New"
},
"columnType": "incoming"
},
{
"id": "5f72391d-af1c-4754-9459-23138eba13e3",
"name": "Approved",
"itemLimit": 5,
"stateMappings": {
"Product Backlog Item": "Approved",
"Bug": "Approved"
},
"isSplit": false,
"description": "",
"columnType": "inProgress"
},
{
"id": "4ddb0875-547e-4d2c-b36a-4ea9a1f7be41",
"name": "Committed",
"itemLimit": 5,
"stateMappings": {
"Product Backlog Item": "Committed",
"Bug": "Committed"
},
"isSplit": false,
"description": "",
"columnType": "inProgress"
},
{
"id": "1016c466-6cb6-4bf9-9a19-4e9cc88204df",
"name": "Done",
"itemLimit": 0,
"stateMappings": {
"Product Backlog Item": "Done",
"Bug": "Done"
},
"columnType": "outgoing"
}
]
}
Get board columns by boardName
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam/Fabrikam Team/_apis/work/boards/{board}/columns?api-version=5.1
Sample Response
{
"count": 4,
"value": [
{
"id": "12eed5fb-8af3-47bb-9d2a-058fbe7e1196",
"name": "New",
"itemLimit": 0,
"stateMappings": {
"Product Backlog Item": "New",
"Bug": "New"
},
"columnType": "incoming"
},
{
"id": "5f72391d-af1c-4754-9459-23138eba13e3",
"name": "Approved",
"itemLimit": 5,
"stateMappings": {
"Product Backlog Item": "Approved",
"Bug": "Approved"
},
"isSplit": false,
"description": "",
"columnType": "inProgress"
},
{
"id": "4ddb0875-547e-4d2c-b36a-4ea9a1f7be41",
"name": "Committed",
"itemLimit": 5,
"stateMappings": {
"Product Backlog Item": "Committed",
"Bug": "Committed"
},
"isSplit": false,
"description": "",
"columnType": "inProgress"
},
{
"id": "1016c466-6cb6-4bf9-9a19-4e9cc88204df",
"name": "Done",
"itemLimit": 0,
"stateMappings": {
"Product Backlog Item": "Done",
"Bug": "Done"
},
"columnType": "outgoing"
}
]
}
Definitions
Name | Description |
---|---|
Board |
|
Board |
BoardColumn
Name | Type | Description |
---|---|---|
columnType | ||
description |
string |
|
id |
string |
|
isSplit |
boolean |
|
itemLimit |
integer |
|
name |
string |
|
stateMappings |
object |
BoardColumnType
Name | Type | Description |
---|---|---|
inProgress |
string |
|
incoming |
string |
|
outgoing |
string |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for