Rows - List

Get rows on a board

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/rows?api-version=7.1-preview.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 '7.1-preview.1' to use this version of the api.

Responses

Name Type Description
200 OK

BoardRow[]

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 a kanban board's rows by boardId
Get a kanban board's rows by boardName

Get a kanban board's rows by boardId

Sample Request

GET https://dev.azure.com/fabrikam/Fabrikam/Fabrikam Team/_apis/work/boards/{board}/rows?api-version=7.1-preview.1

Sample Response

{
  "count": 3,
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": null
    },
    {
      "id": "6dc43426-d087-4047-b0b7-44c03afed8df",
      "name": "Expedite"
    },
    {
      "id": "41c6173f-13a2-42b8-ab75-d96eca02b0bc",
      "name": "Live Site"
    }
  ]
}

Get a kanban board's rows by boardName

Sample Request

GET https://dev.azure.com/fabrikam/Fabrikam/Fabrikam Team/_apis/work/boards/{board}/rows?api-version=7.1-preview.1

Sample Response

{
  "count": 3,
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": null
    },
    {
      "id": "6dc43426-d087-4047-b0b7-44c03afed8df",
      "name": "Expedite"
    },
    {
      "id": "41c6173f-13a2-42b8-ab75-d96eca02b0bc",
      "name": "Live Site"
    }
  ]
}

Definitions

BoardRow

Name Type Description
color

string

id

string

name

string