List Comments
wordpress.list_comments
ActionBusiness appsconnection required
Calls the WordPress API with the connection's credentials.
List comments, optionally for one post. WordPress returns only approved comments unless status asks for another and the user may moderate.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Username & password
- Providers
- WordPress
- Secret shape
- {"username": "…", "password": "… the application password …"}
- Config it needs
- site_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
9 fields, none 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 |
|---|---|---|---|---|---|
post Only comments on this post id. | number | No | — | ≥ 1 | — |
status Moderation status to list. Anything other than approve requires a connection user who can moderate comments. | string | No | — | one of "approve", "hold", "spam", "trash" | — |
parent Only replies to this comment id. | number | No | — | ≥ 0 | — |
search Return only items matching this search string. | string | No | — | — | — |
orderby Attribute the result set is sorted by. | string | No | — | one of "date", "date_gmt", "id", "post", "parent", "type", "include" | — |
order Sort direction for the result set. | string | No | — | one of "asc", "desc" | — |
per_page How many items to return in one page, 1-100. WordPress defaults to 10. | number | No | — | 1–100 | — |
page Which 1-based page of the result set to return. | number | No | — | ≥ 1 | — |
context Response scope. 'view' returns rendered HTML only; 'edit' also returns the raw block markup (title.raw, content.raw) and needs edit rights on the item. | string | No | view | one of "view", "edit", "embed" | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"context": "view"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The objects WordPress returned for this page of results. | array | — |
count How many objects are in items. | number | — |
{
"count": 0,
"items": []
}Notes
- GET /wp/v2/comments. The list filter spells the approved state 'approve', while setting it spells it 'approved' — that asymmetry is WordPress's.
See List Comments run in a workflow.
In a technical demo we add the WordPress connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.