---
schema: rendered-html/v1
title: "Tags | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/resource-api-tags.html
generated_at: 2026-06-11T15:13:44.420217+00:00
---

Feedback

Thanks for your feedback!

Was this page helpful?

YesNo

Developer Portal for YouTrack and Hub

- Developer Portal
- Apps
- MCP Tools
- YouTrack Workflows
- YouTrack Import Scripts
- YouTrack Form API
- YouTrack REST API
- Get Started with REST API
- REST API Reference
- Entities
- Resources
- Activity Items
- Issue Activities Page
- Build Bundles
- Enum Bundles
- Owned Bundles
- State Bundles
- User Bundles
- Version Bundles
- Custom Fields
- Field Types
- Backup Files
- Database Backup Settings
- Global Settings
- Organizations
- Projects
- Telemetry data
- Global Time Tracking Settings
- Agiles
- Articles
- Assigned Roles
- Commands
- Command Suggestions
- User Groups
- Issue Link Types
- Issue Tag
- [Issues](jetbrains__com__help__youtrack__devportal__resource-api-issues.md)
- [Issue Count](jetbrains__com__help__youtrack__devportal__resource-api-issuesgetter-count.md)
- [Permissions](jetbrains__com__help__youtrack__devportal__resource-api-permissions.md)
- [Roles](jetbrains__com__help__youtrack__devportal__resource-api-roles.md)
- [Saved Queries](jetbrains__com__help__youtrack__devportal__resource-api-savedqueries.md)
- [Search Suggestions](jetbrains__com__help__youtrack__devportal__resource-api-search-assist.md)
- [Tags](resource-api-tags.html)
- Operations with Specific Tag
- Sub-resources
- Users
- [My User Profile](jetbrains__com__help__youtrack__devportal__resource-api-users-me.md)
- Issue Work Items
- REST API Use Cases
- REST API Troubleshooting
- Color Indices List
- Hub REST API

1. YouTrack REST API
2. REST API Reference
3. Resources
4. [Tags](#0)

# Tags﻿

Last modified: 24 March 2026

This resource lets you access and work with tags in YouTrack.

| Resource | ``` /api/tags ``` |
| --- | --- |
| Returned entity | Tag. For the description of the entity attributes, see [Supported Fields](/help/youtrack/devportal/resource-api-tags.html#Tag-supported-fields) section. |
| Supported methods | - `GET`: [Read a List of Tags](/help/youtrack/devportal/resource-api-tags.html#get_all-Tag-method). - `POST`: [Add a New Tag](/help/youtrack/devportal/resource-api-tags.html#create-Tag-method). |
| Supported sub-resources | - /api/tags/{tagID} : Operations with Specific Tag - /api/tags/{tagID}/issues : [Issues](jetbrains__com__help__youtrack__devportal__resource-api-tags-tagid-issues.md) |

## Tag attributes﻿

Represents a tag.

### Related Resources﻿

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

- Tags
- [Tagged Issues](jetbrains__com__help__youtrack__devportal__resource-api-tags-tagid-issues.md)
- Issue Tags
- Article Tags
- Tags of a User

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. |

## Read a List of Tags﻿

Get all tags that are visible to the current user.

### Request syntax﻿

```
GET /api/tags?{fields}&{$top}&{$skip}&{query}
```

| null | The 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. |
| $skip | Int | Optional. Lets you set a number of returned entities to skip before returning the first one. |
| $top | Int | Optional. Lets you specify the maximum number of entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries.  The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination. |
| query | String | Tag search query. Use the name of the tag to filter the list of tags. To learn more about search queries, see Query Syntax. |

### Sample﻿

#### Sample request﻿

```
https://example.youtrack.cloud/api/tags?fields=name,owner(login,name),visibleFor(name,id),issues(idReadable,summary)&$skip=4&$top=3
```

#### Sample response body﻿

```
[
  {
    "owner": {
      "login": "john.doe",
      "name": "John Doe",
      "$type": "User"
    "issues": [],
    "visibleFor": null,
    "name": "Useful",
    "$type": "Tag"
  {
    "owner": {
      "login": "jane.doe",
      "name": "Jane Doe",
      "$type": "User"
    "issues": [],
    "visibleFor": {
      "name": "All Users",
      "id": "3-0",
      "$type": "UserGroup"
    "name": "Nice task",
    "$type": "Tag"
  {
    "owner": {
      "login": "john.doe",
      "name": "John Doe",
      "$type": "User"
    "issues": [],
    "visibleFor": {
      "name": "All Users",
      "id": "3-0",
      "$type": "UserGroup"
    "name": "Regression",
    "$type": "Tag"
  }
]
```

## Add a New Tag﻿

Create a new tag.

Required fields: `name`.

### Required permissions﻿

Requires permissions: Create Watch Folder

### Request syntax﻿

```
POST /api/tags?{fields}
```

| null | The 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﻿

Let's create a new tag and share it with a specific user group.

#### Sample request﻿

```
https://example.youtrack.cloud/api/tags?fields=name,owner(login,name),visibleFor(name,id),issues(idReadable,summary)
```

#### Sample request body﻿

```
{
  "name" : "4theRelease!",
  "visibleFor" : {
    "id":"3-2"
  }
}
```

#### Sample response body﻿

```
{
  "owner": {
    "login": "john.doe",
    "name": "John Doe",
    "$type": "User"
  "issues": [],
  "visibleFor": {
    "name": "Sample Project Team",
    "id": "3-2",
    "$type": "UserGroup"
  "name": "4theRelease!",
  "$type": "Tag"
}
```

- [Tags](/help/youtrack/devportal/resource-api-tags.html)
- [Tag attributes](/help/youtrack/devportal/resource-api-tags.html#Tag-supported-fields)
- [Read a List of Tags](/help/youtrack/devportal/resource-api-tags.html#get_all-Tag-method)
- [Add a New Tag](/help/youtrack/devportal/resource-api-tags.html#create-Tag-method)

[Search Suggestions](jetbrains__com__help__youtrack__devportal__resource-api-search-assist.md)Operations with Specific Tag

- Privacy & Security
- Terms Of Use
- Trademarks
- Legal

Copyright © 2000–2026 JetBrains s.r.o.
