Tags - Get

Reference

Service:: Work Item Tracking

API Version:: 7.2-preview.1

Get the tag for the project.

GET https://dev.azure.com/{organization}/{project}/_apis/wit/tags/{tagIdOrName}?api-version=7.2-preview.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
tagIdOrName	path	True	string	Tag ID or tag name.
api-version	query	True	string	Version of the API to use. This should be set to '7.2-preview.1' to use this version of the api.

Responses

Name	Type	Description
200 OK	WorkItemTagDefinition	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 work item tag

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/tags/18090594-b371-4140-99d2-fc93bcbcddec?api-version=7.2-preview.1

Sample Response

Status code:: 200

{
  "id": "18090594-b371-4140-99d2-fc93bcbcddec",
  "name": "my-first-tag",
  "url": "http://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/tags/18090594-b371-4140-99d2-fc93bcbcddec?api-version=5.1-preview",
  "lastUpdated": "2022-11-01T10:56:26.433Z"
}

Definitions

WorkItemTagDefinition

Name	Type	Description
id	string
lastUpdated	string
name	string
url	string