Get comments by IDs - JIRA 7.6.1

Returns a paginated list of comments specified by a list of comment IDs.

This operation can be accessed anonymously.

Permissions required: Comments are returned where the user:

has Browse projects project permission for the project containing the comment.

If issue-level security is configured, issue-level security permission to view the issue.

If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/comment/list' \ --header 'Content-Type: application/json' \ --data-raw '{ "ids": [ 1, 2, 5, 10 ] }'

{"maxResults":1048576,"startAt":0,"total":1,"isLast":true,"values":[{"self":"https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000","id":"10000","author":{"self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false},"body":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"type":"text","text":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."}]}]},"updateAuthor":{"self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","accountId":"5b10a2844c20165700ede21g","displayName":"Mia Krystof","active":false},"created":"2021-01-17T12:34:00.000+0000","updated":"2021-01-18T23:45:00.000+0000","visibility":{"type":"role","value":"Administrators","identifier":"Administrators"}}]}

Request

Query Params

expand

string

optional

Use expand to include additional information about comments in the response. This parameter accepts a comma-separated list. Expand options include:

renderedBody Returns the comment body rendered in HTML.

properties Returns the comment's properties.

Body Params application/json

ids

array[integer <int64>]

required

The list of comment IDs. A maximum of 1000 IDs can be specified.

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

A page of items.

isLast

boolean

read-onlyoptional

Whether this is the last page.

maxResults

integer <int32>

read-onlyoptional

The maximum number of items that could be returned.

string <uri>

read-onlyoptional

If there is another page of results, the URL of the next page.

self

string <uri>

read-onlyoptional

The URL of the page.

startAt

integer <int64>

read-onlyoptional

The index of the first item returned.

total

integer <int64>

read-onlyoptional

The number of items returned.

values

array[object (Comment) {13}]

read-onlyoptional

The list of items.

author

object

read-onlyoptional

The ID of the user who created the comment.

body

optional

The comment text in Atlassian Document Format.

created

string <date-time>

read-onlyoptional

The date and time at which the comment was created.

string

read-onlyoptional

The ID of the comment.

jsdAuthorCanSeeRequest

boolean

read-onlyoptional

Whether the comment was added from an email sent by a person who is not part of the issue. See Allow external emails to be added as comments on issuesfor information on setting up this feature.

jsdPublic

boolean

read-onlyoptional

Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API Create request comment operation.

properties

array[object (EntityProperty) {2}]

optional

A list of comment properties. Optional on create and update.

renderedBody

string

read-onlyoptional

The rendered version of the comment.

self

string

read-onlyoptional

The URL of the comment.

updateAuthor

object

read-onlyoptional

The ID of the user who updated the comment last.

updated

string <date-time>

read-onlyoptional

The date and time at which the comment was updated last.

visibility

object

optional

The group or role to which this comment is visible. Optional on create and update.

Additional properties

integer | number | string | boolean

optional

🟠400Returned if the request contains more than 1000 IDs or is empty.