Backlogs - List

Service:: Work

API Version:: 7.1

List all backlog levels

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

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
team	path	True	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	BacklogLevelConfiguration[]	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 backlogs

Sample request

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber/{team}/_apis/work/backlogs?api-version=7.1

Sample response

Status code:: 200

{
  "count": 4,
  "value": [
    {
      "id": "Microsoft.EpicCategory",
      "name": "Epics",
      "rank": 4,
      "workItemCountLimit": 1000,
      "addPanelFields": [
        {
          "referenceName": "System.Title",
          "name": "Title",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
        }
      ],
      "columnFields": [
        {
          "columnFieldReference": {
            "referenceName": "System.WorkItemType",
            "name": "Work Item Type",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
          },
          "width": 100
        },
        {
          "columnFieldReference": {
            "referenceName": "System.Title",
            "name": "Title",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
          },
          "width": 400
        },
        {
          "columnFieldReference": {
            "referenceName": "System.State",
            "name": "State",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
          },
          "width": 100
        },
        {
          "columnFieldReference": {
            "referenceName": "Microsoft.VSTS.Scheduling.Effort",
            "name": "Effort",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.Effort"
          },
          "width": 50
        },
        {
          "columnFieldReference": {
            "referenceName": "Microsoft.VSTS.Common.BusinessValue",
            "name": "Business Value",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.BusinessValue"
          },
          "width": 50
        },
        {
          "columnFieldReference": {
            "referenceName": "Microsoft.VSTS.Common.ValueArea",
            "name": "Value Area",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.ValueArea"
          },
          "width": 100
        },
        {
          "columnFieldReference": {
            "referenceName": "System.Tags",
            "name": "Tags",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Tags"
          },
          "width": 200
        }
      ],
      "workItemTypes": [
        {
          "name": "Epic",
          "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Epic"
        }
      ],
      "defaultWorkItemType": {
        "name": "Epic",
        "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Epic"
      },
      "color": "FF7B00",
      "isHidden": false,
      "type": "portfolio"
    },
    {
      "id": "Microsoft.FeatureCategory",
      "name": "Features",
      "rank": 3,
      "workItemCountLimit": 1000,
      "addPanelFields": [
        {
          "referenceName": "System.Title",
          "name": "Title",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
        }
      ],
      "columnFields": [
        {
          "columnFieldReference": {
            "referenceName": "System.WorkItemType",
            "name": "Work Item Type",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
          },
          "width": 100
        },
        {
          "columnFieldReference": {
            "referenceName": "System.Title",
            "name": "Title",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
          },
          "width": 400
        },
        {
          "columnFieldReference": {
            "referenceName": "System.State",
            "name": "State",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
          },
          "width": 100
        },
        {
          "columnFieldReference": {
            "referenceName": "Microsoft.VSTS.Scheduling.Effort",
            "name": "Effort",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.Effort"
          },
          "width": 50
        },
        {
          "columnFieldReference": {
            "referenceName": "Microsoft.VSTS.Common.BusinessValue",
            "name": "Business Value",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.BusinessValue"
          },
          "width": 50
        },
        {
          "columnFieldReference": {
            "referenceName": "Microsoft.VSTS.Common.ValueArea",
            "name": "Value Area",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.ValueArea"
          },
          "width": 100
        },
        {
          "columnFieldReference": {
            "referenceName": "System.Tags",
            "name": "Tags",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Tags"
          },
          "width": 200
        }
      ],
      "workItemTypes": [
        {
          "name": "Feature",
          "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Feature"
        }
      ],
      "defaultWorkItemType": {
        "name": "Feature",
        "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Feature"
      },
      "color": "773B93",
      "isHidden": false,
      "type": "portfolio"
    },
    {
      "id": "Microsoft.RequirementCategory",
      "name": "Stories",
      "rank": 2,
      "workItemCountLimit": 1000,
      "addPanelFields": [
        {
          "referenceName": "System.Title",
          "name": "Title",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
        }
      ],
      "columnFields": [
        {
          "columnFieldReference": {
            "referenceName": "System.WorkItemType",
            "name": "Work Item Type",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
          },
          "width": 100
        },
        {
          "columnFieldReference": {
            "referenceName": "System.Title",
            "name": "Title",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
          },
          "width": 400
        },
        {
          "columnFieldReference": {
            "referenceName": "System.State",
            "name": "State",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
          },
          "width": 100
        },
        {
          "columnFieldReference": {
            "referenceName": "Microsoft.VSTS.Scheduling.StoryPoints",
            "name": "Story Points",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.StoryPoints"
          },
          "width": 50
        },
        {
          "columnFieldReference": {
            "referenceName": "Microsoft.VSTS.Common.ValueArea",
            "name": "Value Area",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.ValueArea"
          },
          "width": 100
        },
        {
          "columnFieldReference": {
            "referenceName": "System.IterationPath",
            "name": "Iteration Path",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath"
          },
          "width": 200
        },
        {
          "columnFieldReference": {
            "referenceName": "System.Tags",
            "name": "Tags",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Tags"
          },
          "width": 200
        }
      ],
      "workItemTypes": [
        {
          "name": "User Story",
          "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/User%20Story"
        },
        {
          "name": "Bug",
          "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Bug"
        }
      ],
      "defaultWorkItemType": {
        "name": "User Story",
        "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/User%20Story"
      },
      "color": "009CCC",
      "isHidden": false,
      "type": "requirement"
    },
    {
      "id": "Microsoft.TaskCategory",
      "name": "Tasks",
      "rank": 1,
      "workItemCountLimit": 1000,
      "addPanelFields": [
        {
          "referenceName": "System.Title",
          "name": "Title",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
        }
      ],
      "columnFields": [
        {
          "columnFieldReference": {
            "referenceName": "System.Title",
            "name": "Title",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
          },
          "width": 400
        },
        {
          "columnFieldReference": {
            "referenceName": "System.State",
            "name": "State",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
          },
          "width": 100
        },
        {
          "columnFieldReference": {
            "referenceName": "System.AssignedTo",
            "name": "Assigned To",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.AssignedTo"
          },
          "width": 100
        },
        {
          "columnFieldReference": {
            "referenceName": "Microsoft.VSTS.Scheduling.RemainingWork",
            "name": "Remaining Work",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.RemainingWork"
          },
          "width": 50
        }
      ],
      "workItemTypes": [
        {
          "name": "Task",
          "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Task"
        }
      ],
      "defaultWorkItemType": {
        "name": "Task",
        "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Task"
      },
      "color": "F2CB1D",
      "isHidden": false,
      "type": "task"
    }
  ]
}

Definitions

Name	Description
BacklogColumn
BacklogLevelConfiguration
BacklogType	The type of this backlog level
WorkItemFieldReference	Reference to a field in a work item
WorkItemTypeReference	Reference to a work item type.

BacklogColumn

Object

Name	Type	Description
columnFieldReference	WorkItemFieldReference	Reference to a field in a work item
width	integer (int32)

BacklogLevelConfiguration

Object

Name	Type	Description
addPanelFields	WorkItemFieldReference[]	List of fields to include in Add Panel
color	string	Color for the backlog level
columnFields	BacklogColumn[]	Default list of columns for the backlog
defaultWorkItemType	WorkItemTypeReference	Default Work Item Type for the backlog
id	string	Backlog Id (for Legacy Backlog Level from process config it can be categoryref name)
isHidden	boolean	Indicates whether the backlog level is hidden
name	string	Backlog Name
rank	integer (int32)	Backlog Rank (Taskbacklog is 0)
type	BacklogType	The type of this backlog level
workItemCountLimit	integer (int32)	Max number of work items to show in the given backlog
workItemTypes	WorkItemTypeReference[]	Work Item types participating in this backlog as known by the project/Process, can be overridden by team settings for bugs

BacklogType

Enumeration

The type of this backlog level

Value	Description
portfolio	Portfolio backlog level
requirement	Requirement backlog level
task	Task backlog level

WorkItemFieldReference

Object

Reference to a field in a work item

Name	Type	Description
name	string	The friendly name of the field.
referenceName	string	The reference name of the field.
url	string	The REST URL of the resource.

WorkItemTypeReference

Object

Reference to a work item type.

Name	Type	Description
name	string	Name of the work item type.
url	string

Share via

Backlogs - List

URI Parameters

Responses

Security

oauth2

Scopes

Examples

Get backlogs

Sample request

Sample response

Definitions

BacklogColumn

BacklogLevelConfiguration

BacklogType

WorkItemFieldReference

WorkItemTypeReference