provider Issue comments GET /rest/api/3/issue/{issueIdOrKey}/comment
@utdk/jira /rest/api/3/issue/{issueIdOrKey}/comment
Get comments
Returns all comments for an issue. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Comments are included in the response where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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.
issueIdOrKey path required
The ID or key of the issue.
string
startAt query
The index of the first item to return in a page of results (page offset).
integer
maxResults query
The maximum number of items to return per page.
integer
orderBy query
[Order](#ordering) the results by a field. Accepts *created* to sort comments by their created date.
enum: created, -created, +created
expand query
Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.
string

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getcomments
GET/rest/api/3/issue/{issueIdOrKey}/comment
Returns all comments for an issue. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Comments are included in the response where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) 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.

Parameters

required

The ID or key of the issue.

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

The maximum number of items to return per page.

[Order](#ordering) the results by a field. Accepts *created* to sort comments by their created date.

Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.getcomments({
  "startAt": 0,
  "maxResults": 100
})