List Task Comments
clickup.list_task_comments
ActionBusiness appsconnection required
Calls the ClickUp API with the connection's credentials.
List a task's comments by its task id, newest first. ClickUp returns the 25 most recent unless start and start_id are given.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- ClickUp
- Secret shape
- the API token (pk_…), or {"token": "…"}
- Config it needs
- list_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 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 |
|---|---|---|---|---|---|
task_id The task id, e.g. '9hx' — the last segment of the task's URL. | string | Yes | — | — | — |
start Page from this Unix timestamp in milliseconds; must be set with start_id. | integer | No | — | ≥ 0 | — |
start_id Comment id to page from; must be set with start. | string | Conditional | — | only with start | — |
custom_task_ids Treat task_id as the Workspace's custom task id (e.g. 'ABC-123') rather than ClickUp's own id. team_id becomes required when this is on. | boolean | No | false | — | — |
team_id The Workspace (team) id. Only needed — and then required — when custom_task_ids is on. | string | Conditional | — | only with custom_task_ids | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"custom_task_ids": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items One entry per row ClickUp returned. | array | — |
count How many rows are in items. | number | — |
{
"count": 0,
"items": []
}See List Task Comments run in a workflow.
In a technical demo we add the ClickUp connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.