List Comments

jira.list_comments

ActionBusiness appsconnection required

Calls the Jira Cloud REST API with the connection's email and API token.

List the comments on a Jira issue.

Ask about Jira All Jira nodes Provider API docs ↗

Connection

Required: Yes — the node will not save without one
Auth type: Username & password
Providers: Jira
Secret shape: {"email", "api_token"}
Config it needs: domain
Resolved by: config.connection_id, else node.connection_id

Configuration

4 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

Field	Type	Required	Default	Constraints	Example
issue_key Issue key or numeric id, e.g. PROJ-123. Supports {{ }}.	string	Yes	—	—	—
start_at Index of the first result to return, for paging through a long list.	number	No	0	≥ 0	—
max_results Maximum results to return in one call.	number	No	50	≥ 1	—
order_by Sort order by creation date.	string	No	—	one of "created", "-created", "+created"	—

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "max_results": 50,
  "start_at": 0
}

Output

One shape.

result

Field	Type	Example
comments[].id The comment's id.	string	—
comments[].author.displayName Who wrote the comment.	string	—
comments[].created When it was written, ISO-8601.	string	—
comments[].updated When it was last edited, ISO-8601.	string	—
comments[].body The comment body as an ADF document.	object	—
count How many items this call returned.	number	—
total How many items match in total, when Jira reports one.	number	—
start_at Index of the first item in this page.	number	—

{
  "comments": [
    {
      "author": {
        "displayName": ""
      },
      "body": {},
      "created": "",
      "id": "",
      "updated": ""
    }
  ],
  "count": 0,
  "start_at": 0,
  "total": 0
}

Notes

Bodies come back as ADF, not text — read comments[].body.content to render them.

Related Jira nodes

Templates that use Jira

Solutions with Jira

See List Comments run in a workflow.

In a technical demo we add the Jira connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demo Talk to sales