# Article Comments

This resource lets you work with comments to an article.
|  Resource  |     ```GENERIC /api/articles/{articleID}/comments ```    |
| --- | --- |
|  Returned entity  |  [ArticleComment](api-entity-ArticleComment.html). For the description of the entity attributes, see [Supported Fields](#ArticleComment-supported-fields) section.  |
|  Supported methods  |      * `GET`: [Read a List of ArticleComments](#get_all-ArticleComment-method).    * `POST`: [Add a New ArticleComment](#create-ArticleComment-method).    |
|  Supported sub-resources  |      * [/api/articles/{articleID}/comments/{commentID}](operations-api-articles-articleID-comments.html)    * [/api/articles/{articleID}/comments/{commentID}/reactions](resource-api-articles-articleID-comments-commentID-reactions.html)    |

## ArticleComment attributes

Represents a comment to an article.

### Related Resources

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

* [Article Comments]()

### Attributes

This table describes attributes of the `ArticleComment` 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 article comment. `Read-only`.  |
|  article  |  [BaseArticle](api-entity-BaseArticle.html)  |  The article the comment belongs to. `Read-only`. `Can be null`.  |
|  attachments  |  [Array of ArticleAttachments](api-entity-ArticleAttachment.html)  |  The list of attachments that are attached to the comment.  |
|  author  |  [User](api-entity-User.html)  |  The user who created the comment. `Read-only`. `Can be null`.  |
|  created  |  Long  |  The timestamp in milliseconds indicating the moment when the comment was posted. Stored as a unix timestamp at UTC. `Read-only`.  |
|  pinned  |  Boolean  |  Determines whether the comment is pinned in the article.  |
|  reactions  |  [Array of Reactions](api-entity-Reaction.html)  |  The list of reactions that users added to this comment.  |
|  text  |  String  |  The text of the comment. `Can be null`.  |
|  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](api-entity-Visibility.html)  |  The visibility settings of the comment. They define who is allowed to see the comment. `Can be null`.  |

## Read a List of ArticleComments

Get all accessible comments to a specific article.

### Request syntax

```GENERIC
GET /api/articles/{articleID}/comments?{fields}&{$top}&{$skip}
```

|  null  |  The database ID of ArticleComment  |
| --- | --- |

### Request parameters

|  Parameter  |  Type  |  Description  |
| --- | --- | --- |
|  fields  |  String  |  A list of ArticleComment 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](api-concept-pagination.html).     |

### Sample

#### Sample request

```CURL
https://example.youtrack.cloud/api/articles/NP-A-7/comments?fields=id,author(id,name),text,created,visibility(permittedGroups(id,name),permittedUsers(id,name))
```

#### Sample response body

```JSON
[
  {
    "author": {
      "name": "John Smith",
      "id": "24-0",
      "$type": "User"
    },
    "created": 1629984248559,
    "visibility": {
      "$type": "UnlimitedVisibility"
    },
    "text": "Hello world!",
    "id": "251-0",
    "$type": "ArticleComment"
  }
]
```

## Add a New ArticleComment

Add a new comment to the article.

Required fields: `text`.

### Required permissions

Requires permissions: Create Comment

### Request syntax

```GENERIC
POST /api/articles/{articleID}/comments?{fields}&{draftId}&{muteUpdateNotifications}
```

|  null  |  The database ID of ArticleComment  |
| --- | --- |

### Request parameters

|  Parameter  |  Type  |  Description  |
| --- | --- | --- |
|  fields  |  String  |  A list of ArticleComment attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.  |
|  draftId  |  String  |  The 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

```CURL
https://example.youtrack.cloud/api/articles/NP-A-7/comments?fields=id,author(id,name),text,created,visibility(permittedGroups(id,name),permittedUsers(id,name))
```

#### Sample request body

```JSON
{
  "text": "Jane, please update the information in this article."
}
```

#### Sample response body

```JSON
{
  "author": {
    "name": "John Smith",
    "id": "24-0",
    "$type": "User"
  },
  "created": 1629984897621,
  "visibility": {
    "$type": "UnlimitedVisibility"
  },
  "text": "Jane, please update the information in this article.",
  "id": "251-2",
  "$type": "ArticleComment"
}
```