GET /rest/api/2/issue/{issueIdOrKey}/comment

Returns all comments for an issue.

This operation can be accessed anonymously.

Permissions required: Comments are included in the response where the user has:

Servers

Path parameters

Name Type Required Description
issueIdOrKey String Yes

The ID or key of the issue.

Query parameters

Name Type Required Description
startAt Integer No

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

Default value: 0

maxResults Integer No

The maximum number of items to return per page.

Default value: 100

orderBy String No

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

Possible values:

  • "+created"
  • "created"
  • "-created"
expand String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.