List comments with the WordPress.com API

Lists the comments of a site, newest first, with found as the total and the post of each comment in post. Only approved ones by default; status unapproved lists the moderation queue. The last page is when page times number reaches found.

Identifier
wordpress_com_list_comments

The request

POST https://connect.reportei.com/api/tools/wordpress_com_list_comments/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "site": "<site>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
sitestringYesID of the site, from List sites, or its domain, like example.wordpress.com.
statusstringNoapproved, the default, lists the public comments; unapproved the moderation queue; spam and trash those folders; all every comment.Values: approved, unapproved, spam, trash, all
afterstringNoOnly comments made on or after this moment.
beforestringNoOnly comments made on or before this moment.
orderstringNoDESC, the default, is newest first; ASC is oldest first.Values: DESC, ASC
numberintegerNoComments per page, up to 100. The default is 20.
pageintegerNoPage to return, starting at 1.

Supported connections

Your customer connects their WordPress.com account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/wordpress_com, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/wordpress_com_list_comments. It becomes your agent's tool definition with no conversion.

Other WordPress.com tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.