Issue comments

Get comments by IDs

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.
post/rest/api/3/comment/list

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/comment/list
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:jira-work
    • or none

Query parameters

expandstring

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.

Request body

idsinteger[] required

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

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

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

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.

Changes

No recorded changes to this operation across all 36 revisions of this API.