WP REST API v2 Documentation

Schema

The schema defines all the fields that exist for a comment object.

`id` integer	Unique identifier for the object. Read only Context: `view`, `edit`, `embed`
`author` integer	The ID of the user object, if author was a user. Context: `view`, `edit`, `embed`
`author_email` string, email	Email address for the object author. Context: `edit`
`author_ip` string, ip	IP address for the object author. Context: `edit`
`author_name` string	Display name for the object author. Context: `view`, `edit`, `embed`
`author_url` string, uri	URL for the object author. Context: `view`, `edit`, `embed`
`author_user_agent` string	User agent for the object author. Context: `edit`
`content` object	The content for the object. Context: `view`, `edit`, `embed`
`date` string, datetime (ISO8601)	The date the object was published. Context: `view`, `edit`, `embed`
`date_gmt` string, datetime (ISO8601)	The date the object was published as GMT. Context: `view`, `edit`
`link` string, uri	URL to the object. Read only Context: `view`, `edit`, `embed`
`parent` integer	The ID for the parent of the object. Context: `view`, `edit`, `embed`
`post` integer	The ID of the associated post object. Context: `view`, `edit`
`status` string	State of the object. Context: `view`, `edit`
`type` string	Type of Comment for the object. Read only Context: `view`, `edit`, `embed`
`author_avatar_urls` object	Avatar URLs for the object author. Read only Context: `view`, `edit`, `embed`
`meta` object	Meta fields. Context: `view`, `edit`

Example Request

$ curl -X OPTIONS -i http://demo.wp-api.org/wp-json/wp/v2/comments

List Comments

Arguments

`context`	Scope under which the request is made; determines fields present in response. Default: `view` One of: `view`, `embed`, `edit`
`page`	Current page of the collection. Default: `1`
`per_page`	Maximum number of items to be returned in result set. Default: `10`
`search`	Limit results to those matching a string.
`after`	Limit response to comments published after a given ISO8601 compliant date.
`author`	Limit result set to comments assigned to specific user IDs. Requires authorization.
`author_exclude`	Ensure result set excludes comments assigned to specific user IDs. Requires authorization.
`author_email`	Limit result set to that from a specific author email. Requires authorization.
`before`	Limit response to comments published before a given ISO8601 compliant date.
`exclude`	Ensure result set excludes specific IDs. Default:
`include`	Limit result set to specific IDs. Default:
`offset`	Offset the result set by a specific number of comments.
`order`	Order sort attribute ascending or descending. Default: `desc` One of: `asc`, `desc`
`orderby`	Sort collection by object attribute. Default: `date_gmt` One of: `date`, `date_gmt`, `id`, `include`, `post`, `parent`, `type`
`parent`	Limit result set to comments of specific parent IDs. Default:
`parent_exclude`	Ensure result set excludes specific parent IDs. Default:
`post`	Limit result set to comments assigned to specific post IDs. Default:
`status`	Limit result set to comments assigned a specific status. Requires authorization. Default: `approve`
`type`	Limit result set to comments assigned a specific type. Requires authorization. Default: `comment`
`password`	The password for the post if it is password protected.

Definition

GET /wp/v2/comments

Example Request

$ curl http://demo.wp-api.org/wp-json/wp/v2/comments

Retrieve a Comment

Arguments

context

Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

password

The password for the post if it is password protected.

Definition

GET /wp/v2/comments/<id>

Example Request

$ curl http://demo.wp-api.org/wp-json/wp/v2/comments/<id>

Create a Comment

Arguments

`author`	The ID of the user object, if author was a user.
`author_email`	Email address for the object author.
`author_ip`	IP address for the object author.
`author_name`	Display name for the object author.
`author_url`	URL for the object author.
`author_user_agent`	User agent for the object author.
`content`	The content for the object.
`date`	The date the object was published.
`date_gmt`	The date the object was published as GMT.
`parent`	The ID for the parent of the object. Default: `0`
`post`	The ID of the associated post object. Default: `0`
`status`	State of the object.
`meta`	Meta fields.

Definition

POST /wp/v2/comments

Update a Comment

Arguments

`author`	The ID of the user object, if author was a user.
`author_email`	Email address for the object author.
`author_ip`	IP address for the object author.
`author_name`	Display name for the object author.
`author_url`	URL for the object author.
`author_user_agent`	User agent for the object author.
`content`	The content for the object.
`date`	The date the object was published.
`date_gmt`	The date the object was published as GMT.
`parent`	The ID for the parent of the object.
`post`	The ID of the associated post object.
`status`	State of the object.
`meta`	Meta fields.

Definition

POST /wp/v2/comments/<id>

Example Request

Delete a Comment

Arguments

`force`	Whether to bypass trash and force deletion.
`password`	The password for the post if it is password protected.

Definition

DELETE /wp/v2/comments/<id>

Example Request

$ curl -X DELETE http://demo.wp-api.org/wp-json/wp/v2/comments/<id>