Share via


Pull Request Labels

Pull Request labels (tags) provide extensibility to the pull request experience. Third party services or users with read permission in the repository can create (add), get, and delete labels (tags) associated with a pull request via this REST API. The names for the labels is shared with work item tags. There is separate REST API used to manage the list of tags. Labels (tags) are used to provide quick insights into a pull request, an example can be labelling a Pull request as "WIP", "Feature", or "Bug" to let others know the state and purpose of the Pull Request.

Labels are posted to the pull request and will be displayed in both the details and list views for pull requests.

Operations

Create

Create a tag (if that does not exists yet) and add that as a label (tag) for a specified pull request. The only required field is the name of the new label (tag...

Delete

Removes a label (tag) from the set of those assigned to the pull request. The tag itself will not be deleted.

Get

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

List

Get all the labels (tags) assigned to a pull request.