Work Item Type Categories - List

Get all work item type categories.

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypecategories?api-version=5.0

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

api-version
query True
  • string

Version of the API to use. This should be set to '5.0' 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

Sample Request

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitemtypecategories?api-version=5.0

Sample Response

{
  "count": 14,
  "value": [
    {
      "name": "Bug Category",
      "referenceName": "Microsoft.BugCategory",
      "defaultWorkItemType": {
        "name": "Bug",
        "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Bug"
      },
      "workItemTypes": [
        {
          "name": "Bug",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Bug"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypeCategories/Microsoft.BugCategory"
    },
    {
      "name": "Feature Category",
      "referenceName": "Microsoft.FeatureCategory",
      "defaultWorkItemType": {
        "name": "Feature",
        "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Feature"
      },
      "workItemTypes": [
        {
          "name": "Feature",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Feature"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypeCategories/Microsoft.FeatureCategory"
    },
    {
      "name": "Requirement Category",
      "referenceName": "Microsoft.RequirementCategory",
      "defaultWorkItemType": {
        "name": "Product Backlog Item",
        "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Product%20Backlog%20Item"
      },
      "workItemTypes": [
        {
          "name": "Product Backlog Item",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Product%20Backlog%20Item"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypeCategories/Microsoft.RequirementCategory"
    },
    {
      "name": "Test Case Category",
      "referenceName": "Microsoft.TestCaseCategory",
      "defaultWorkItemType": {
        "name": "Test Case",
        "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Test%20Case"
      },
      "workItemTypes": [
        {
          "name": "Test Case",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Test%20Case"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypeCategories/Microsoft.TestCaseCategory"
    },
    {
      "name": "Shared Step Category",
      "referenceName": "Microsoft.SharedStepCategory",
      "defaultWorkItemType": {
        "name": "Shared Steps",
        "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Shared%20Steps"
      },
      "workItemTypes": [
        {
          "name": "Shared Steps",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Shared%20Steps"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypeCategories/Microsoft.SharedStepCategory"
    },
    {
      "name": "Code Review Request Category",
      "referenceName": "Microsoft.CodeReviewRequestCategory",
      "defaultWorkItemType": {
        "name": "Code Review Request",
        "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Code%20Review%20Request"
      },
      "workItemTypes": [
        {
          "name": "Code Review Request",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Code%20Review%20Request"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypeCategories/Microsoft.CodeReviewRequestCategory"
    },
    {
      "name": "Code Review Response Category",
      "referenceName": "Microsoft.CodeReviewResponseCategory",
      "defaultWorkItemType": {
        "name": "Code Review Response",
        "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Code%20Review%20Response"
      },
      "workItemTypes": [
        {
          "name": "Code Review Response",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Code%20Review%20Response"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypeCategories/Microsoft.CodeReviewResponseCategory"
    },
    {
      "name": "Feedback Request Category",
      "referenceName": "Microsoft.FeedbackRequestCategory",
      "defaultWorkItemType": {
        "name": "Feedback Request",
        "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Feedback%20Request"
      },
      "workItemTypes": [
        {
          "name": "Feedback Request",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Feedback%20Request"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypeCategories/Microsoft.FeedbackRequestCategory"
    },
    {
      "name": "Feedback Response Category",
      "referenceName": "Microsoft.FeedbackResponseCategory",
      "defaultWorkItemType": {
        "name": "Feedback Response",
        "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Feedback%20Response"
      },
      "workItemTypes": [
        {
          "name": "Feedback Response",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Feedback%20Response"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypeCategories/Microsoft.FeedbackResponseCategory"
    },
    {
      "name": "Task Category",
      "referenceName": "Microsoft.TaskCategory",
      "defaultWorkItemType": {
        "name": "Task",
        "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
      },
      "workItemTypes": [
        {
          "name": "Task",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Task"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypeCategories/Microsoft.TaskCategory"
    },
    {
      "name": "Hidden Types Category",
      "referenceName": "Microsoft.HiddenCategory",
      "defaultWorkItemType": {
        "name": "Code Review Request",
        "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Code%20Review%20Request"
      },
      "workItemTypes": [
        {
          "name": "Code Review Request",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Code%20Review%20Request"
        },
        {
          "name": "Code Review Response",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Code%20Review%20Response"
        },
        {
          "name": "Feedback Request",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Feedback%20Request"
        },
        {
          "name": "Feedback Response",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Feedback%20Response"
        },
        {
          "name": "Shared Steps",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Shared%20Steps"
        },
        {
          "name": "Shared Parameter",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Shared%20Parameter"
        },
        {
          "name": "Test Plan",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Test%20Plan"
        },
        {
          "name": "Test Suite",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Test%20Suite"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypeCategories/Microsoft.HiddenCategory"
    },
    {
      "name": "Shared Parameter Category",
      "referenceName": "Microsoft.SharedParameterCategory",
      "defaultWorkItemType": {
        "name": "Shared Parameter",
        "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Shared%20Parameter"
      },
      "workItemTypes": [
        {
          "name": "Shared Parameter",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Shared%20Parameter"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypeCategories/Microsoft.SharedParameterCategory"
    },
    {
      "name": "Test Plan Category",
      "referenceName": "Microsoft.TestPlanCategory",
      "defaultWorkItemType": {
        "name": "Test Plan",
        "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Test%20Plan"
      },
      "workItemTypes": [
        {
          "name": "Test Plan",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Test%20Plan"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypeCategories/Microsoft.TestPlanCategory"
    },
    {
      "name": "Test Suite Category",
      "referenceName": "Microsoft.TestSuiteCategory",
      "defaultWorkItemType": {
        "name": "Test Suite",
        "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Test%20Suite"
      },
      "workItemTypes": [
        {
          "name": "Test Suite",
          "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypes/Test%20Suite"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/workItemTypeCategories/Microsoft.TestSuiteCategory"
    }
  ]
}

Definitions

ReferenceLinks

The class to represent a collection of REST reference links.

WorkItemTypeCategory

Describes a work item type category.

WorkItemTypeReference

Reference to a work item type.

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.

WorkItemTypeCategory

Describes a work item type category.

Name Type Description
_links

Link references to related REST resources.

defaultWorkItemType

Gets or sets the default type of the work item.

name
  • string

The name of the category.

referenceName
  • string

The reference name of the category.

url
  • string
workItemTypes

The work item types that belond to the category.

WorkItemTypeReference

Reference to a work item type.

Name Type Description
name
  • string

Name of the work item type.

url
  • string