List Issue Comments
github.list_issue_comments
ActionBusiness appsconnection required
Calls GET /repos/{owner}/{repo}/issues/{issue_number}/comments.
List the comments on one issue or pull request.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- GitHub
- Secret shape
- the GitHub personal access token
- Resolved by
- config.connection_id, else node.connection_id, else the tenant's sole GitHub connection
Configuration
5 fields, 3 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 |
|---|---|---|---|---|---|
owner Repository owner — the user or organisation login. Supports {{ }}. | string | Yes | — | — | octocat |
repo Repository name, without the owner prefix. Supports {{ }}. | string | Yes | — | — | hello-world |
issue_number Issue number as shown in the UI (not the internal id). | string | Yes | — | — | 1 |
since Only comments updated at or after this ISO 8601 timestamp. | string | No | — | iso8601 format | — |
max_items Stop after this many rows; further pages are followed via the Link header. | number | No | 100 | 1–1000 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"issue_number": "1",
"max_items": 100,
"owner": "octocat",
"repo": "hello-world"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
comments The comments this step read. | array | — |
comments[].id Comment id, used to update or delete it. | number | — |
comments[].body Comment text (Markdown). | string | — |
comments[].user_login Who wrote it. | string | — |
comments[].html_url Link to the comment. | string | — |
comments[].created_at When it was written, ISO 8601. | string | — |
count How many rows this step returned. | number | — |
{
"comments": [
{
"body": "",
"created_at": "",
"html_url": "",
"id": 0,
"user_login": ""
}
],
"count": 0
}Solutions with GitHub
See List Issue Comments run in a workflow.
In a technical demo we add the GitHub connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.