v4

latestOpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Issue comments

Get comments

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.
get/rest/api/3/issue/{issueIdOrKey}/comment

Path parameters

issueIdOrKeystring required

The ID or key of the issue.

Query parameters

startAtinteger

The index of the first item to return in a page of results (page offset).

maxResultsinteger

The maximum number of items to return per page.

orderBy'created' | '-created' | '+created'

Order the results by a field. Accepts created to sort comments by their created date.

expandstring

Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

Response

Returned if the request is successful.

maxResultsinteger

The maximum number of items that could be returned.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.