Boards - Get

Get board

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{id}?api-version=7.1

URI Parameters

Name In Required Type Description
id
path True

string

identifier for board, either board's backlog level name (Eg:"Stories") or Id

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' to use this version of the api.

Responses

Name Type Description
200 OK

Board

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.

Definitions

Name Description
Board
BoardColumn
BoardColumnType
BoardFields
BoardRow
FieldReference

An abstracted reference to a field

ReferenceLinks

The class to represent a collection of REST reference links.

Board

Name Type Description
_links

ReferenceLinks

The class to represent a collection of REST reference links.

allowedMappings

object

canEdit

boolean

columns

BoardColumn[]

fields

BoardFields

id

string

Id of the resource

isValid

boolean

name

string

Name of the resource

revision

integer

rows

BoardRow[]

url

string

Full http link to the resource

BoardColumn

Name Type Description
columnType

BoardColumnType

description

string

id

string

isSplit

boolean

itemLimit

integer

name

string

stateMappings

object

BoardColumnType

Name Type Description
inProgress

string

incoming

string

outgoing

string

BoardFields

Name Type Description
columnField

FieldReference

An abstracted reference to a field

doneField

FieldReference

An abstracted reference to a field

rowField

FieldReference

An abstracted reference to a field

BoardRow

Name Type Description
color

string

id

string

name

string

FieldReference

An abstracted reference to a field

Name Type Description
referenceName

string

fieldRefName for the field

url

string

Full http link to more information about the field

The class to represent a collection of REST reference links.

Name Type Description
links

object

The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.