List Comments
notion.list_comments
ActionBusiness appsconnection required
Calls the Notion API with the connection's credentials.
List the unresolved comments on a page or block.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Notion
- Secret shape
- the integration token, or {"token": "…"}
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 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 |
|---|---|---|---|---|---|
block_id Page id for page-level comments, or a block id for an inline discussion. | string | Yes | — | — | — |
page_size How many results to return, 1-100 (Notion's default is 100). | number | No | — | 1–100 | — |
start_cursor The 'next_cursor' from a previous call, to fetch the following page. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
results The objects Notion returned for this page of results. | array | — |
count How many objects came back in this call. | number | — |
has_more True when another page of results exists. | boolean | — |
next_cursor Cursor to pass as 'start_cursor' for the next page; null on the last page. | string | — |
{
"count": 0,
"has_more": false,
"next_cursor": "",
"results": []
}Notes
- Resolved comments are never returned by the API.
- The integration needs the 'read comments' capability, which is off by default.
See List Comments run in a workflow.
In a technical demo we add the Notion connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.