List Comments
figma.list_comments
ActionBusiness appsconnection required
Calls the Figma API with the connection's credentials.
List every comment and reply left on a Figma file.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Figma
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"}, or {"personal_access_token": "figd_…"}
- Config it needs
- base_url, plan_api_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 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 |
|---|---|---|---|---|---|
file_key The Figma file key — the segment after /design/ or /file/ in the file URL. | string | Yes | — | — | — |
as_markdown Return comment bodies as Markdown where Figma can convert them. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"as_markdown": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
comments The comments on the file, replies included. | array | — |
count How many comments were returned. | number | — |
{
"comments": [],
"count": 0
}See List Comments run in a workflow.
In a technical demo we add the Figma connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.