Get Comments
GET {{baseUrl}}/rest/api/3/issue/:issueIdOrKey/comment?startAt=0&maxResults=50&orderBy=<string>&expand=<string>
Returns all comments for an issue.
This operation can be accessed anonymously.
Permissions required: Comments are included in the response 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 role visibility is restricted to.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
startAt | number | The index of the first item to return in a page of results (page offset). | |
maxResults | number | The maximum number of items to return per page. | |
orderBy | string | Order the results by a field. Accepts created to sort comments by their created date. | |
expand | string | Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML. |
RESPONSES
status: OK
{"startAt":0,"maxResults":1,"total":1,"comments":[{"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":"2020-12-17T01:45:40.265+0000","updated":"2020-12-17T01:45:40.265+0000","visibility":{"type":"role","value":"Administrators"}}]}