{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Issue Comments API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Issue Comments", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get Comments By Ids", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/comment/list", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `renderedBody` Returns the comment body rendered in HTML.\n * `properties` Returns the comment's properties." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a [paginated](#pagination) list of comments specified by a list of comment IDs.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** Comments are returned 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 is" }, { "info": { "name": "Atlassian Get Comments", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/comment", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue." }, { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "orderBy", "value": "", "type": "query", "description": "[Order](#ordering) the results by a field. Accepts *created* to sort comments by their created date." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML." } ] }, "docs": "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 visibi" }, { "info": { "name": "Atlassian Add Comment", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/comment", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a comment to an issue.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:**

* *Browse projects* and *Add comments* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue." }, { "info": { "name": "Atlassian Get Comment", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/comment/:id", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the comment." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML." } ] }, "docs": "Returns a comment.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:**

* *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, the user belongs to the group or has the role visibilit" }, { "info": { "name": "Atlassian Update Comment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/comment/:id", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the comment." }, { "name": "notifyUsers", "value": "", "type": "query", "description": "Whether users are notified when a comment is updated." }, { "name": "overrideEditableFlag", "value": "", "type": "query", "description": "Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a comment.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:**

* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *Edit all comments*[ project permission](https://confluence.atlassian.com/x/yo" }, { "info": { "name": "Atlassian Delete Comment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/comment/:id", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the comment." } ] }, "docs": "Deletes a comment.

**[Permissions](#permissions) required:**

* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *Delete all comments*[ project permission](https://confluence.atlassian.com/x/yodKLg) to delete any comment or *Delete own commen" } ] } ], "bundled": true }