POST /rest/api/2/comment/list

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:

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
expand String No

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 fields

Name Type Required Description
ids[] Array Yes

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

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.