---
schema: rendered-html/v1
title: "Issue Comments | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/resource-api-issues-issueID-comments.html
generated_at: 2026-06-11T15:12:45.363673+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](jetbrains__com__help__youtrack__devportal__resource-api-issuetags.md)
- Issues
- Operations with Specific Issue
- Sub-resources
- [Issue Activity Items](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-activities.md)
- [Activity Cursor Page](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-activitiespage.md)
- [Issue Attachments](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-attachments.md)
- [Issue Comments](resource-api-issues-issueID-comments.html)
- Operations with Specific IssueComment
- Sub-resources
- [Issue Custom Fields](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-customfields.md)
- [Issue Links](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-links.md)
- [Issue Project](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-project.md)
- [Issue Sprints](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-sprints.md)
- [Tags](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-tags.md)
- Issue Time Tracking
- Issue VCS Changes and Pull Requests
- Issue Count
- Permissions
- Roles
- Saved Queries
- Search Suggestions
- Tags
- Users
- My User Profile
- 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. Issues
5. [Sub-resources](#0)
6. [Issue Comments](#0)

# Issue Comments﻿

Last modified: 24 March 2026

This resource lets you work with comments of an issue.

| Resource | ``` /api/issues/{issueID}/comments ``` |
| --- | --- |
| Returned entity | IssueComment. For the description of the entity attributes, see [Supported Fields](/help/youtrack/devportal/resource-api-issues-issueID-comments.html#IssueComment-supported-fields) section. |
| Supported methods | - `GET`: [Read a List of IssueComments](/help/youtrack/devportal/resource-api-issues-issueID-comments.html#get_all-IssueComment-method). - `POST`: [Add a New IssueComment](/help/youtrack/devportal/resource-api-issues-issueID-comments.html#create-IssueComment-method). |
| Supported sub-resources | - /api/issues/{issueID}/comments/{commentID} : Operations with Specific IssueComment - /api/issues/{issueID}/comments/{commentID}/reactions : [Reactions](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-comments-commentid-reactions.md) |

## IssueComment attributes﻿

Represents an existing issue comment.

### Related Resources﻿

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

- Issue Comments

### Attributes﻿

This table describes attributes of the `IssueComment` 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 vote for the duplicate issue. `Read-only`. |
| attachments | Array of IssueAttachments | The list of attachments that are attached to the comment. |
| author | User | The user who created the comment. `Read-only`. `Can be null`. |
| created | Long | The timestamp in milliseconds indicating the moment the comment was posted. Stored as a unix timestamp at UTC. `Read-only`. |
| deleted | Boolean | When `true`, the comment is considered to be deleted, otherwise false. |
| issue | Issue | The issue the comment belongs to. `Read-only`. `Can be null`. |
| pinned | Boolean | Determines whether the comment is pinned in the issue. |
| reactions | Array of Reactions | The list of reactions that users added to this comment. |
| text | String | The text of the comment. `Can be null`. |
| textPreview | String | The comment text as it is shown in UI after processing with wiki/markdown (including HTML markup). `Read-only`. |
| updated | Long | The timestamp in milliseconds indicating the last update of the comment. Stored as a unix timestamp at UTC. `Read-only`. `Can be null`. |
| visibility | Visibility | Visibility settings of the comment. They define who is allowed to see the comment. `Can be null`. |

## Read a List of IssueComments﻿

Get all accessible comments of the specific issue.

### Request syntax﻿

GET /api/issues/{issueID}/comments?{fields}&{$top}&{$skip}

| null | The database ID of IssueComment |
| --- | --- |

### Request parameters﻿

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | A list of IssueComment 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. |

### Sample﻿

#### Sample request﻿

https://example.youtrack.cloud/api/issues/2-31/comments?fields=id,author%28login,name,id%29,deleted,text,updated,visibility%28permittedGroups%28name,id%29,permittedUsers%28id,name,login%29%29

#### Sample response body﻿

[
  {
    "author": {
      "login": "jane.doe",
      "name": "Jane Doe",
      "id": "1-3"
    },
    "deleted": false,
    "updated": null,
    "text": "@john.doe let's update the summary and description",
    "visibility": {
      "permittedGroups": [
        {
          "name": "Sample Project Team",
          "id": "3-2"
        }
      ],
      "permittedUsers": [],
      "$type": "LimitedVisibility"
    },
    "id": "4-0"
  },
  {
    "author": {
      "login": "john.doe",
      "name": "John Doe",
      "id": "1-2"
    },
    "deleted": false,
    "updated": 1533223079255,
    "text": "okay, let's do it, @jane.doe. I am btw updating this from rest",
    "visibility": {
      "$type": "UnlimitedVisibility"
    },
    "id": "4-2"
  }
]

## Add a New IssueComment﻿

Add a new comment to an issue with a specific ID.

Required fields: `text`.

### Required permissions﻿

Requires permissions: Create Comment

### Request syntax﻿

POST /api/issues/{issueID}/comments?{fields}&{draftId}&{muteUpdateNotifications}

| null | The database ID of IssueComment |
| --- | --- |

### Request parameters﻿

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | A list of IssueComment attributes that should be returned in the response. If no field is specified, only the `entityID` is returned. |
| draftId | String | ID of an existing draft that should be published. This parameter is optional. |
| muteUpdateNotifications | Boolean | Set this parameter to `true` if no notifications should be sent on changes made by this request. This doesn't mute notifications sent by any workflow rules. Using this parameter requires Apply Commands Silently permission in all projects affected by the request. Available since 2021.3. |

### Sample﻿

#### Sample request﻿

https://example.youtrack.cloud/api/issues/2-6/comments?fields=id,author%28login,name,id%29,deleted,text,updated,visibility%28permittedGroups%28name,id%29,permittedUsers%28id,name,login%29%29

#### Sample request body﻿

{
  "text": "Disregard the previous comment. The problem still requires investigation.",
  "visibility": {
    "permittedGroups": [
      {
        "id": "3-2"
      }
    ],
    "$type": "LimitedVisibility"
  }
}

#### Sample response body﻿

{
  "author": {
    "login": "john.doe",
    "name": "John Doe",
    "id": "1-2",
    "$type": "User"
  },
  "deleted": false,
  "text": "Disregard the previous comment. The problem still requires investigation.",
  "visibility": {
    "permittedUsers": [],
    "permittedGroups": [
      {
        "name": "Sample Project Team",
        "id": "3-2",
        "$type": "UserGroup"
      }
    ],
    "$type": "LimitedVisibility"
  },
  "updated": null,
  "id": "4-14",
  "$type": "IssueComment"
}

- [Issue Comments](/help/youtrack/devportal/resource-api-issues-issueID-comments.html)
- [IssueComment attributes](/help/youtrack/devportal/resource-api-issues-issueID-comments.html#IssueComment-supported-fields)
- [Read a List of IssueComments](/help/youtrack/devportal/resource-api-issues-issueID-comments.html#get_all-IssueComment-method)
- [Add a New IssueComment](/help/youtrack/devportal/resource-api-issues-issueID-comments.html#create-IssueComment-method)

Operations with Specific IssueAttachmentOperations with Specific IssueComment

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

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

![](https://bat.bing.com/action/0?ti=5220035&tm=gtm002&Ver=2&mid=effd0d18-a0c8-4d3c-b5a2-05b543443a7f&bo=4&sid=452929b065a111f19a7fe7356f74a419&vid=aa3122f0648711f1a10d6d095e10fd87&vids=0&msclkid=N&pi=918639831&lg=en-US&sw=1920&sh=1080&sc=24&tl=Issue%20Comments%20%7C%20Developer%20Portal%20for%20YouTrack%20and%20Hub%20Documentation&p=https%3A%2F%2Fwww.jetbrains.com%2Fhelp%2Fyoutrack%2Fdevportal%2Fresource-api-issues-issueID-comments.html&r=&lt=988&pt=1781190761915,38,38,,,3,3,3,3,3,,3,34,35,43,225,225,226,986,988,988&pn=0,0&evt=pageLoad&sv=2&asc=G&cdb=AQAS&rn=690280)
