Pull Request Labels - Get

Service:

Git

API Version:

7.1

Retrieves a single label (tag) that has been assigned to a pull request.

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/labels/{labelIdOrName}?api-version=7.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/labels/{labelIdOrName}?projectId={projectId}&api-version=7.1

URI Parameters

Name	In	Required	Type	Description
labelIdOrName	path	True	string	The name or ID of the label requested.
organization	path	True	string	The name of the Azure DevOps organization.
pullRequestId	path	True	integer (int32)	ID of the pull request.
repositoryId	path	True	string	The repository ID of the pull request’s target branch.
project	path		string	Project ID or project 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.
projectId	query		string	Project ID or project name.

Responses

Name	Type	Description
200 OK	WebApiTagDefinition	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.code	Grants the ability to read source code and metadata about commits, changesets, branches, and other version control artifacts. Also grants the ability to search code and get notified about version control events via service hooks.

Definitions

WebApiTagDefinition

Object

The representation of a tag definition which is sent across the wire.

Name	Type	Description
active	boolean	Whether or not the tag definition is active.
id	string (uuid)	ID of the tag definition.
name	string	The name of the tag definition.
url	string	Resource URL for the Tag Definition.