Get Comments By Ids

POST {{baseUrl}}/rest/api/3/comment/list?expand=<string>

Returns a paginated list of just the comments for a list of comments specified by 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.

Request Params

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

Request Body

{"ids"=>["<long>"]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{&quot;maxResults&quot;:1048576,&quot;startAt&quot;:0,&quot;total&quot;:1,&quot;isLast&quot;:true,&quot;values&quot;:[{&quot;self&quot;:&quot;https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000&quot;,&quot;id&quot;:&quot;10000&quot;,&quot;author&quot;:{&quot;self&quot;:&quot;https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g&quot;,&quot;accountId&quot;:&quot;5b10a2844c20165700ede21g&quot;,&quot;displayName&quot;:&quot;Mia Krystof&quot;,&quot;active&quot;:false},&quot;body&quot;:{&quot;type&quot;:&quot;doc&quot;,&quot;version&quot;:1,&quot;content&quot;:[{&quot;type&quot;:&quot;paragraph&quot;,&quot;content&quot;:[{&quot;type&quot;:&quot;text&quot;,&quot;text&quot;:&quot;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.&quot;}]}]},&quot;updateAuthor&quot;:{&quot;self&quot;:&quot;https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g&quot;,&quot;accountId&quot;:&quot;5b10a2844c20165700ede21g&quot;,&quot;displayName&quot;:&quot;Mia Krystof&quot;,&quot;active&quot;:false},&quot;created&quot;:&quot;2020-12-17T01:45:40.265+0000&quot;,&quot;updated&quot;:&quot;2020-12-17T01:45:40.265+0000&quot;,&quot;visibility&quot;:{&quot;type&quot;:&quot;role&quot;,&quot;value&quot;:&quot;Administrators&quot;}}]}