Operations with Specific Tag

Last modified: 19 March 2025

This sub-resource lets you work with the tags that are added to the specific issue.

Resource

/api/issues/{issueID}/tags/{tagID}

Returned entity

Tag. For the description of the entity attributes, see Supported Fields section.

Supported methods

Tag attributes

Represents a tag.

Related Resources

Below you can find the list of resources that let you work with this entity.

Extends WatchFolder

Attributes

This table describes attributes of the Tag entity.

  • To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

id

String

The ID of the tag. Read-only.

issues

Array of Issues

The collection of issues that this tag is added to.

color

FieldStyle

The color settings of the tag.

untagOnResolve

Boolean

If true, this tag will be automatically removed from an issue when the issue is resolved.

visibleFor

UserGroup

Deprecated. Use the readSharingSettings attribute instead.

Group of users that can see this tag. If the tag is visible only to its owner, this property is null.

Can be null.

updateableBy

UserGroup

Deprecated. Use the updateSharingSettings attribute instead.

Group of users that can update this tag. If only the tag's owner can update it, this property is null.

Can be null.

readSharingSettings

WatchFolderSharingSettings

Users and groups that can see this tag. If the tag is visible only to its owner, this property contains an empty array. Read-only.

tagSharingSettings

TagSharingSettings

Users and groups that can use this tag. These users can add the tag to or remove the tag from the issues that they also have permission to view and update. If the tag can be used only by its owner, this property contains an empty array. Read-only.

updateSharingSettings

WatchFolderSharingSettings

Users and groups that can update this tag. If only the tag's owner can update it, this property contains an empty array. Read-only.

owner

User

The user who created the watch folder. Read-only. Can be null.

name

String

The name of the issue folder. Can be null.

Read a Specific Tag

Read a specific tag added to the issue.

Required permissions

The user must be either the tag owner or be a part of the user group the tag is shared with.

Request syntax

GET /api/issues/{issueID}/tags/{tagID}?{fields}

{tagID}

The database ID of the tag.

Request parameters

Parameter

Type

Description

fields

String

A list of Tag attributes that should be returned in the response. If no field is specified, only the entityID is returned.

Sample

Sample request

Sample response body

{
  "owner": {
    "login": "jane.doe",
    "name": "Jane Doe",
    "$type": "User"
  },
  "visibleFor": {
    "name": "All Users",
    "id": "23-0",
    "$type": "UserGroup"
  },
  "name": "Blocked by dependency",
  "$type": "Tag"
}

Remove a Tag from the Issue

Remove a specific tag from the issue.

Required permissions

Requires permissions: Read Issue, Update Issue

Request syntax

{tagID}

Database ID of Tag

Request parameters

Parameter

Type

Description

fields

String

A list of Tag attributes that should be returned in the response. If no field is specified, only the entityID is returned.

Sample

Sample request