Version 1.0
Connector Overview: This page documents all 64 actions for the Wordpressconnector v1.0.
Block Renderer
GET Retrieve a Rendered-block
/wp-json/wp/v2/block-renderer/{blockName}
|
|
|
|---|---|
|
`` |
Unique registered name for the block. |
|
`` |
Scope under which the request is made; determines fields present in response.
|
|
`` |
Attributes for core/tag-cloud block |
|
`` |
ID of the post context. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The name of the block (e.g., core/paragraph) to render. |
|
|
The response format expected from the API (e.g. application/json). |
Block Revisions (3)
POST Create a wp_block-revision
/wp-json/wp/v2/{blockId}/autosaves
|||
|:--|:--
|``parent``|The ID for the parent of the object.
|``date``|The date the object was published, in the site's timezone.
|``date_gmt``|The date the object was published, as GMT.
|``slug``|An alphanumeric identifier for the object unique to its type.
|``status``|A named status for the object.
One of: publish, future, draft, pending, private
|``password``|A password to protect access to the content and excerpt.
|``title``|The title for the object.
|``content``|The content for the object.
|``template``|The theme file to use to display the object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the block to create an autosave for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a wp_block-revision
/wp-json/wp/v2/blocks/{blockId}/autosaves
|
|
|
|
|
|---|---|---|---|
|
`` |
The ID for the parent of the object.
|
|
|
|
`` |
Scope under which the request is made; |
`` |
fields present in response.
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The parent block ID to filter revisions by (if applicable). |
|
|
The ID of the block whose revisions to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a wp_block-revision with parent
/wp-json/wp/v2/blocks/{parentId}/autosaves/{blockId}
|
|
|
|---|---|
|
`` |
The ID for the parent of the object. |
|
`` |
The ID for the object. |
|
`` |
Scope under which the request is made; determines fields present in response.
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the parent block. |
|
|
The ID of the specific revision to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
Blocks (5)
POST Create a wp_block
/wp-json/wp/v2/blocks
|
|
|
|---|---|
|
`` |
The date the object was published, in the site's timezone. |
|
`` |
The date the object was published, as GMT. |
|
`` |
An alphanumeric identifier for the object unique to its type. |
|
`` |
A named status for the object.
|
|
`` |
A password to protect access to the content and excerpt. |
|
`` |
The title for the object. |
|
`` |
The content for the object. |
|
`` |
The theme file to use to display the object. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The title for the new reusable block. |
|
|
The HTML content of the block. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete a wp_block
/wp-json/wp/v2/blocks/{blockId}
|
|
|
|---|---|
|
`` |
Unique identifier for the object. |
|
`` |
Whether to bypass trash and force deletion. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Set to 1 to force deletion without trashing. |
|
|
The ID of the block to delete. |
|
|
The response format expected from the API (e.g. application/json). |
GET List wp_blocks
/wp-json/wp/v2/blocks
|
|
|
|---|---|
|
`` |
Scope under which the request is made; determines fields present in response.
|
|
`` |
Current page of the collection.
|
|
`` |
Maximum number of items to be returned in result set.
|
|
`` |
Limit results to those matching a string. |
|
`` |
Limit response to posts published after a given ISO8601 compliant date. |
|
`` |
Limit response to posts published before a given ISO8601 compliant date. |
|
`` |
Ensure result set excludes specific IDs. |
|
`` |
Limit result set to specific IDs. |
|
`` |
Offset the result set by a specific number of items. |
|
`` |
Order sort attribute ascending or descending.
|
|
`` |
Sort collection by object attribute.
|
|
`` |
Limit result set to posts with one or more specific slugs. |
|
`` |
Limit result set to posts assigned one or more statuses.
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a wp_block
/wp-json/wp/v2/blocks/{blockId}
|
|
|
|---|---|
|
`` |
Unique identifier for the object. |
|
`` |
Scope under which the request is made; determines fields present in response.
|
|
`` |
The password for the post if it is password protected. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the block to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
POST Updating a wp_block
/wp-json/wp/v2/blocks/{blockId}
|
|
|
|---|---|
|
`` |
Unique identifier for the object. |
|
`` |
The date the object was published, in the site's timezone. |
|
`` |
The date the object was published, as GMT. |
|
`` |
An alphanumeric identifier for the object unique to its type. |
|
`` |
A named status for the object.
|
|
`` |
A password to protect access to the content and excerpt. |
|
`` |
The title for the object. |
|
`` |
The content for the object. |
|
`` |
The theme file to use to display the object. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The new HTML content for the block. |
|
|
The new title for the block. |
|
|
The ID of the block to update. |
|
|
The response format expected from the API (e.g. application/json). |
Categories (5)
POST Create a category
/wp-json/wp/v2/categories
|
|
|
|---|---|
|
`` |
HTML description of the term. |
|
`` |
HTML title for the term.
|
|
`` |
An alphanumeric identifier for the term unique to its type. |
|
`` |
The parent term ID. |
|
`` |
Meta fields. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The display name for the new category. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete a Category
/wp-json/wp/v2/categories/{categoriesId}
|
|
|
|---|---|
|
`` |
Unique identifier for the term. |
|
`` |
Required to be true, as terms do not support trashing. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Set to 1 to force deletion without trashing. |
|
|
The ID of the category to delete. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Categories
/wp-json/wp/v2/categories
|||
|:--|:--
|``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.
|``exclude``|Ensure result set excludes specific IDs.
|``include``|Limit result set to specific IDs.
|``order``|Order sort attribute ascending or descending.
Default: asc
One of: asc, desc
|``orderby``|Sort collection by term attribute.
Default: name
One of: id, include, name, slug, include_slugs, term_group, description, count
|``hide_empty``|Whether to hide terms not assigned to any posts.
|``parent``|Limit result set to terms assigned to a specific parent.
|``post``|Limit result set to terms assigned to a specific post.
|``slug``|Limit result set to terms with one or more specific slugs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a Category
/wp-json/wp/v2/categories/{categoriesId}
|
|
|
|---|---|
|
`` |
Unique identifier for the term. |
|
`` |
Scope under which the request is made; determines fields present in response.
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the category to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update a Category
/wp-json/wp/v2/categories/{categoriesId}
|
|
|
|---|---|
|
`` |
Unique identifier for the term. |
|
`` |
HTML description of the term. |
|
`` |
HTML title for the term. |
|
`` |
An alphanumeric identifier for the term unique to its type. |
|
`` |
The parent term ID. |
|
`` |
Meta fields. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The new name for the category. |
|
|
The ID of the category to update. |
|
|
The response format expected from the API (e.g. application/json). |
Comments (5)
POST Create a Comment
/wp-json/wp/v2/comments
|
|
|
|---|---|
|
`` |
The ID of the associated post object.
|
|
`` |
The content for the object.
|
|
`` |
The ID of the user object, if author was a user. |
|
`` |
Email address for the object author. |
|
`` |
IP address for the object author. |
|
`` |
Display name for the object author. |
|
`` |
URL for the object author. |
|
`` |
User agent for the object author. |
|
`` |
The content for the object. |
|
`` |
The date the object was published, in the site's timezone. |
|
`` |
The date the object was published, as GMT. |
|
`` |
The ID for the parent of the object. |
|
`` |
State of the object. |
|
`` |
Meta fields. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the post to comment on. |
|
|
The comment text. |
|
|
The display name of the comment author. |
|
|
The email address of the comment author. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete a Comment
/wp-json/wp/v2/comments/{commentId}
|
|
|
|---|---|
|
`` |
Unique identifier for the object. |
|
`` |
Whether to bypass trash and force deletion. |
|
`` |
The password for the parent post of the comment (if the post is password protected). |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the comment to delete. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Comments
/wp-json/wp/v2/comments
|
|
|
|---|---|
|
`` |
Scope under which the request is made; determines fields present in response.
|
|
`` |
Current page of the collection.
|
|
`` |
Maximum number of items to be returned in result set.
|
|
`` |
Limit results to those matching a string. |
|
`` |
Limit response to comments published after a given ISO8601 compliant date. |
|
`` |
Limit result set to comments assigned to specific user IDs. Requires authorization. |
|
`` |
Ensure result set excludes comments assigned to specific user IDs. Requires authorization. |
|
`` |
Limit result set to that from specific author email. Requires authorization. |
|
`` |
Limit response to comments published before a given ISO8601 compliant date. |
|
`` |
Ensure result set excludes specific IDs. |
|
`` |
Limit result set to specific IDs. |
|
`` |
Offset the result set by a specific number of items. |
|
`` |
Order sort attribute ascending or descending.
|
|
`` |
Sort collection by object attribute.
|
|
`` |
Limit result set to comments of specific parent IDs. |
|
`` |
Ensure result set excludes specific parent IDs. |
|
`` |
Limit result set to comments assigned to specific post IDs. |
|
`` |
Limit result set to comments assigned a specific status. Requires authorization.
|
|
`` |
Limit result set to comments assigned a specific type. Requires authorization.
|
|
`` |
The password for the post if it is password protected. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a Comment
/wp-json/wp/v2/comments/{commentId}
Authentication Required
|
|
|
|---|---|
|
`` |
Unique identifier for the object. |
|
`` |
Scope under which the request is made; determines fields present inresponse.
|
|
`` |
The password for the parent post of the comment (if the post is password protected). |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the comment to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update a Comment
/ /wp-json/wp/v2/comments/{commentId}
|
|
|
|---|---|
|
`` |
Unique identifier for the object. |
|
`` |
The ID of the user object, if author was a user. |
|
`` |
Email address for the object author. |
|
`` |
IP address for the object author. |
|
`` |
Display name for the object author. |
|
`` |
URL for the object author. |
|
`` |
User agent for the object author. |
|
`` |
The content for the object. |
|
`` |
The date the object was published, in the site's timezone. |
|
`` |
The date the object was published, as GMT. |
|
`` |
The ID for the parent of the object. |
|
`` |
The ID of the associated post object. |
|
`` |
State of the object. |
|
`` |
Meta fields. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The new text content for the comment. |
|
|
The ID of the comment to update. |
|
|
The response format expected from the API (e.g. application/json). |
Media (5)
POST Create a Media item
/wp-json/wp/v2/media
|||
|:--|:--
|``date``|The date the object was published, in the site's timezone.
|``date_gmt``|The date the object was published, as GMT.
|``slug``|An alphanumeric identifier for the object unique to its type.
|``status``|A named status for the object.
One of: publish, future, draft, pending, private
|``title``|The title for the object.
|``author``|The ID for the author of the object.
|``comment_status``|Whether or not comments are open on the object.
One of: open, closed
|``ping_status``|Whether or not the object can be pinged.
One of: open, closed
|``meta``|Meta fields.
|``template``|The theme file to use to display the object.
|``alt_text``|Alternative text to display when attachment is not displayed.
|``caption``|The attachment caption.
|``description``|The attachment description.
|``post``|The ID for the associated post of the attachment.
Multiple different ways to do this. The way I illustrate here is:
Set the ``Content-Type`` to the image file type.
Set ``Content-Disposition` to ``form-data;filename="YOUR-FILENAME.FILE_TYPE"
Set the binary to the file you wish to upload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
some test param |
DELETE Delete a Media item
/wp-json/wp/v2/media/{mediaId}
|||
|:--|:--
|``id``|Unique identifier for the object.
|``force``|Whether to bypass trash and force deletion.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Set to 1 to force deletion without trashing. |
|
|
The ID of the media item to delete. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Media
/wp-json/wp/v2/media
|
|
|
|---|---|
|
`` |
Scope under which the request is made; determines fields present in response.
|
|
`` |
Current page of the collection.
|
|
`` |
Maximum number of items to be returned in result set.
|
|
`` |
Limit results to those matching a string. |
|
`` |
Limit response to posts published after a given ISO8601 compliant date. |
|
`` |
Limit result set to posts assigned to specific authors. |
|
`` |
Ensure result set excludes posts assigned to specific authors. |
|
`` |
Limit response to posts published before a given ISO8601 compliant date. |
|
`` |
Ensure result set excludes specific IDs. |
|
`` |
Limit result set to specific IDs. |
|
`` |
Offset the result set by a specific number of items. |
|
`` |
Order sort attribute ascending or descending.
|
|
`` |
Sort collection by object attribute.
|
|
`` |
Limit result set to items with particular parent IDs. |
|
`` |
Limit result set to all items except those of a particular parent ID. |
|
`` |
Limit result set to posts with one or more specific slugs. |
|
`` |
Limit result set to posts assigned one or more statuses.
|
|
`` |
Limit result set to attachments of a particular media type.
|
|
`` |
Limit result set to attachments of a particular MIME type. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a Media item
/wp-json/wp/v2/media/{mediaId}
|||
|:--|:--
|``id``|Unique identifier for the object.
|``context``|Scope under which the request is made; determines fields present in response.
Default: view
One of: view, embed, edit
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the media item to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update a Media item
/wp-json/wp/v2/media/{mediaId}
|||
|:--|:--
|``id``|Unique identifier for the object.
|``date``|The date the object was published, in the site's timezone.
|``date_gmt``|The date the object was published, as GMT.
|``slug``|An alphanumeric identifier for the object unique to its type.
|``status``|A named status for the object.
One of: publish, future, draft, pending, private
|``title``|The title for the object.
|``author``|The ID for the author of the object.
|``comment_status``|Whether or not comments are open on the object.
One of: open, closed
|``ping_status``|Whether or not the object can be pinged.
One of: open, closed
|``meta``|Meta fields.
|``template``|The theme file to use to display the object.
|``alt_text``|Alternative text to display when attachment is not displayed.
|``caption``|The attachment caption.
|``description``|The attachment description.
|``post``|The ID for the associated post of the attachment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The new caption text for the media item. |
|
|
The ID of the media item to update. |
|
|
The response format expected from the API (e.g. application/json). |
Misc (4)
GET Google Sheet Data
/integromat!A2:A3
Retrieve data from a Google Sheet range defined in the endpoint path.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The API key required to access the Google Sheet data. |
|
|
The response format expected from the API (e.g. application/json). |
POST New Request
/
Send a new request to the WordPress HTTP API to trigger a custom action.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The action name to execute via the WordPress HTTP API. |
|
|
The API key required to authenticate the request. |
|
|
The specific action to perform within the custom request. |
|
|
The author ID or username to associate with the post. |
|
|
The title to use for the new post (expected as an integer, likely an ID). |
|
|
The response format expected from the API (e.g. application/json). |
POST Post Tip
/Dr3OQkjzY3fdNNEwe8x7
Submit a tip or feedback with two custom values.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The first value to include in the tip. |
|
|
The second value to include in the tip. |
|
|
The response format expected from the API (e.g. application/json). |
GET Routes
/wp-json
Returns all the available API routes and endpoints for a Wordpress instance.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Pages (5)
POST Create a Page
/wp-json/wp/v2/pages
|
|
|
|---|---|
|
`` |
The date the object was published, in the site's timezone. |
|
`` |
The date the object was published, as GMT. |
|
`` |
An alphanumeric identifier for the object unique to its type. |
|
`` |
A named status for the object.
|
|
`` |
A password to protect access to the content and excerpt. |
|
`` |
The ID for the parent of the object. |
|
`` |
The title for the object. |
|
`` |
The content for the object. |
|
`` |
The ID for the author of the object. |
|
`` |
The excerpt for the object. |
|
`` |
The ID of the featured media for the object. |
|
`` |
Whether or not comments are open on the object.
|
|
`` |
Whether or not the object can be pinged.
|
|
`` |
The order of the object in relation to other object of its type. |
|
`` |
Meta fields. |
|
`` |
The theme file to use to display the object. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The new text content for the comment. |
|
|
The new title for the block. |
|
|
The excerpt or summary for the new page. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete a Page
/wp-json/wp/v2/pages/{pageId}
|||
|:--|:--
|``id``|Unique identifier for the object.
|``force``|Whether to bypass trash and force deletion.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the page to delete. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Pages
/wp-json/wp/v2/pages
|
|
|
|---|---|
|
`` |
Scope under which the request is made; determines fields present in response.
|
|
`` |
Current page of the collection.
|
|
`` |
Maximum number of items to be returned in result set.
|
|
`` |
Limit results to those matching a string. |
|
`` |
Limit response to posts published after a given ISO8601 compliant date. |
|
`` |
Limit result set to posts assigned to specific authors. |
|
`` |
Ensure result set excludes posts assigned to specific authors. |
|
`` |
Limit response to posts published before a given ISO8601 compliant date. |
|
`` |
Ensure result set excludes specific IDs. |
include Limit result set to specific IDs.
|``menu_order``|Limit result set to posts with a specific menu_order value.
|``offset``|Offset the result set by a specific number of items.
|``order``|Order sort attribute ascending or descending.
Default: desc
One of: asc, desc
|``orderby``|Sort collection by object attribute.
Default: date
One of: author, date, id, include, modified, parent, relevance, slug, include_slugs, title, menu_order
|``parent``|Limit result set to items with particular parent IDs.
|``parent_exclude``|Limit result set to all items except those of a particular parent ID.
|``slug``|Limit result set to posts with one or more specific slugs.
|``status``|Limit result set to posts assigned one or more statuses.
Default: publish
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a Page
/wp-json/wp/v2/pages/{pageId}
|
|
|
|---|---|
|
`` |
Unique identifier for the object. |
|
`` |
Scope under which the request is made; determines fields present in response.
|
|
`` |
The password for the post if it is password protected. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the page to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update a Page
/wp-json/wp/v2/pages/{pageId}
|
|
|
|---|---|
|
`` |
Unique identifier for the object. |
|
`` |
The date the object was published, in the site's timezone. |
|
`` |
The date the object was published, as GMT. |
|
`` |
An alphanumeric identifier for the object unique to its type. |
|
`` |
A named status for the object.
|
|
`` |
A password to protect access to the content and excerpt. |
|
`` |
The ID for the parent of the object. |
|
`` |
The title for the object. |
|
`` |
The content for the object. |
|
`` |
The ID for the author of the object. |
|
`` |
The excerpt for the object. |
|
`` |
The ID of the featured media for the object. |
|
`` |
Whether or not comments are open on the object.
|
|
`` |
Whether or not the object can be pinged.
|
|
`` |
The order of the object in relation to other object of its type. |
|
`` |
Meta fields. |
|
`` |
The theme file to use to display the object. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The new title for the block. |
|
|
The new text content for the comment. |
|
|
The new excerpt for the page. |
|
|
The unique identifier of the page to update. |
|
|
The response format expected from the API (e.g. application/json). |
Post Revisions (3)
DELETE Delete a Post-revision
/wp/v2/posts/{parentId}/revisions/{revisionsId}
| | |
| :--- | :--
|``parent``|The ID for the parent of the object.
|``id``|Unique identifier for the object.
|``force``|Required to be true, as revisions do not support trashing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the parent block. |
|
|
The unique identifier of the revision to delete. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Post Revisions
/wp/v2/posts/{postId}/revisions
| | |
| :-- | :--
|``parent`` |The ID for the parent of the object.
|``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.
|``search``|Limit results to those matching a string.
|``exclude``|Ensure result set excludes specific IDs.
|``include`` | Limit result set to specific IDs.
|``offset``|Offset the result set by a specific number of items.
|``order``|Order sort attribute ascending or descending.
Default: desc
One of: asc, desc
|``orderby``|Sort collection by object attribute.
Default: date
One of: date, id, include, relevance, slug, include_slugs, title
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the parent post. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a Post-Revision
/wp/v2/posts/{parentId}/revisions/{revisionId}
| | |
|:--|:--
|``parent``|The ID for the parent of the object.
|``id``|Unique identifier for the object.
|``context``|Scope under which the request is made; determines fields present in response.
Default: view
One of: view, embed, edit
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the parent block. |
|
|
The unique identifier of the revision to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
Posts (5)
POST Create Posts
/wp-json/wp/v2/posts
|
|
|
|---|---|
|
`` |
The date the object was published, in the site's timezone. |
|
`` |
The date the object was published, as GMT. |
|
`` |
An alphanumeric identifier for the object unique to its type. |
|
`` |
A named status for the object.
|
|
`` |
A password to protect access to the content and excerpt. |
|
`` |
The title for the object. |
|
`` |
The content for the object. |
|
`` |
The ID for the author of the object. |
|
`` |
The excerpt for the object. |
|
`` |
The ID of the featured media for the object. |
|
`` |
Whether or not comments are open on the object.
|
|
`` |
Whether or not the object can be pinged.
|
|
`` |
The format for the object.
|
|
`` |
Meta fields. |
|
`` |
Whether or not the object should be treated as sticky. |
|
`` |
The theme file to use to display the object. |
|
`` |
The terms assigned to the object in the category taxonomy. |
|
`` |
The terms assigned to the object in the post_tag taxonomy. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The title of the new post. |
|
|
The content or body of the new post. |
DELETE Delete a Post
/wp-json/wp/v2/posts/{postId}
|
|
|
|---|---|
|
`` |
Unique identifier for the object. |
|
`` |
Whether to bypass trash and force deletion. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the post to delete. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Posts
/wp-json/wp/v2/posts
List Posts
| | |
| :-- | :--
|``context``|Scope under which the request is made; determines fields present in response.
Default: view
One of: view, embed, edit
|``page`` | Current page of 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 posts published after a given ISO8601 compliant date.
|``author``|Limit result set to posts assigned to specific authors.
|``author_exclude``|Ensure result set excludes posts assigned to specific authors.
|``before``|Limit response to posts published before a given ISO8601 compliant date.
|``exclude``|Ensure result set excludes specific IDs.
|``include``|Limit result set to specific IDs.
|``order``|Order sort attribute ascending or descending.
Default: desc
One of: asc, desc
|``orderby``| Sort collection by object attribute.
Default: date
One of: author, date, id, include, modified, parent, relevance, slug, include_slugs, title
|``slug``|Limit result set to posts with one or more specific slugs.
|``status``|Limit result set to posts assigned one or more statuses.
Default: publish
|``categories``|Limit result set to all items that have the specified term assigned in the categories taxonomy.
|``categories_exclude``|Limit result set to all items except those that have the specified term assigned in the categories taxonomy.
|``tags``|Limit result set to all items that have the specified term assigned in the tags taxonomy.
|``tags_exclude``|Limit result set to all items except those that have the specified term assigned in the tags taxonomy.
|``sticky``|Limit result set to items that are sticky.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The scope under which the request is made, such as 'view' or 'edit'. |
|
|
The page number of the results to retrieve. |
|
|
The number of posts to return per page. |
|
|
A search term to filter posts by title or content. |
|
|
ISO8601 date string to return posts published after this date. |
|
|
ISO8601 date string to return posts modified after this date. |
|
|
Author ID to filter posts by a specific author. |
|
|
Post status to filter by, such as 'publish', 'draft', or 'pending'. |
|
|
Comma-separated tag IDs to filter posts by those tags. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a Post
/wp-json/wp/v2/posts/{postId}
|
|
|
|---|---|
|
`` |
Unique identifier for the object. |
|
`` |
Scope under which the request is made; determines fields present in response.
|
|
`` |
The password for the post if it is password protected. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the post to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update a Post
/wp-json/wp/v2/posts/{postId}
|
|
|
|---|---|
|
`` |
Unique identifier for the object. |
|
`` |
The date the object was published, in the site's timezone. |
|
`` |
The date the object was published, as GMT. |
|
`` |
An alphanumeric identifier for the object unique to its type. |
|
`` |
A named status for the object.
|
|
`` |
A password to protect access to the content and excerpt. |
|
`` |
The title for the object. |
|
`` |
The content for the object. |
|
`` |
The ID for the author of the object. |
|
`` |
The excerpt for the object. |
|
`` |
The ID of the featured media for the object. |
|
`` |
Whether or not comments are open on the object.
|
|
`` |
Whether or not the object can be pinged.
|
|
`` |
The format for the object.
|
|
`` |
Meta fields. |
|
`` |
Whether or not the object should be treated as sticky. |
|
`` |
The theme file to use to display the object. |
|
`` |
The terms assigned to the object in the category taxonomy. |
|
`` |
The terms assigned to the object in the post_tag taxonomy. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The new text content for the comment. |
|
|
The new title for the block. |
|
|
The new excerpt for the post. |
|
|
The unique identifier of the post to update. |
|
|
The response format expected from the API (e.g. application/json). |
Search Results
GET List Search-results
/wp-json/wp/v2/search
|
|
|
|---|---|
|
`` |
Scope under which the request is made; determines fields present in response.
|
|
`` |
Current page of the collection.
|
|
`` |
Maximum number of items to be returned in result set.
|
|
`` |
Limit results to those matching a string. |
|
`` |
Limit results to items of an object type.
|
|
`` |
Limit results to items of one or more object subtypes.
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Settings (2)
GET Retrieve Site Settings
/wp-json/wp/v2/settings
There are no arguments for this endpoint.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update Site Settings
/wp-json/wp/v2/settings
|
|
|
|---|---|
|
`` |
Site title. |
|
`` |
Site tagline. |
|
`` |
A city in the same timezone as you. |
|
`` |
A date format for all date strings. |
|
`` |
A time format for all time strings. |
|
`` |
A day number of the week that the week should start on. |
|
`` |
WordPress locale code. |
|
`` |
Convert emoticons like :-) and :-P to graphics on display. |
|
`` |
Default post category. |
|
`` |
Default post format. |
|
`` |
Blog pages show at most. |
|
`` |
Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.
|
|
`` |
Allow people to post comments on new articles.
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Statuses (2)
GET Retrieve a Status
/wp-json/wp/v2/statuses
|
|
|
|---|---|
|
`` |
Scope under which the request is made; determines fields present in response.
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a Status
/wp-json/wp/v2/statuses/{statusId}
|
|
|
|---|---|
|
`` |
An alphanumeric identifier for the status. |
|
`` |
Scope under which the request is made; determines fields present in response.
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The identifier (slug) of the status to retrieve, for example "publish" or "draft". |
|
|
The response format expected from the API (e.g. application/json). |
Tags (5)
POST Create a Tag
/wp-json/wp/v2/tags
|
|
|
|---|---|
|
`` |
HTML description of the term. |
|
`` |
HTML title for the term.
|
|
`` |
An alphanumeric identifier for the term unique to its type. |
|
`` |
Meta fields. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The new name for the category. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete a Tag
/wp-json/wp/v2/tags/{tagId}
|
|
|
|---|---|
|
`` |
Unique identifier for the term. |
|
`` |
Required to be true, as terms do not support trashing. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Set to 1 to force deletion without trashing. |
|
|
The numeric identifier of the tag to delete. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Tags
/wp-json/wp/v2/tags
|||
|:--|:---
|``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.
|``exclude``|Ensure result set excludes specific IDs.
|``include``|Limit result set to specific IDs.
|``offset``|Offset the result set by a specific number of items.
|``order``|Order sort attribute ascending or descending.
Default: asc
One of: asc, desc
|``orderby``|Sort collection by term attribute.
Default: name
One of: id, include, name, slug, include_slugs, term_group, description, count
|``hide_empty``|Whether to hide terms not assigned to any posts.
|``post``|Limit result set to terms assigned to a specific post.
|``slug``|Limit result set to terms with one or more specific slugs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a Tag
/wp-json/wp/v2/tags/{tagId}
|
|
|
|
|
|---|---|---|---|
|
`` |
Unique identifier for the term. |
|
|
|
`` |
Scope under which the request is made; |
`` |
fields present in response.
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The numeric identifier of the tag to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update a Tag
/wp-json/wp/v2/tags/{tagId}
|
|
|
|---|---|
|
`` |
Unique identifier for the term. |
|
`` |
HTML description of the term. |
|
`` |
HTML title for the term. |
|
`` |
An alphanumeric identifier for the term unique to its type. |
|
`` |
Meta fields. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The new name for the category. |
|
|
The numeric identifier of the tag to update. |
|
|
The response format expected from the API (e.g. application/json). |
Taxonomies (2)
GET Retrieve a Taxonomy
/wp-json/wp/v2/taxonomies
|
|
|
|---|---|
|
`` |
Scope under which the request is made; determines fields present in response.
|
|
`` |
Limit results to taxonomies associated with a specific post type. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a Taxonomy
/wp-json/wp/v2/taxonomies/{taxonomy}
|||
|:--|:--
|``taxonomy``|An alphanumeric identifier for the taxonomy.
|``context``|Scope under which the request is made; determines fields present in response.Default: view
One of: view, embed, edit
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The slug of the taxonomy to retrieve, for example "category" or "post_tag". |
|
|
The response format expected from the API (e.g. application/json). |
Themes
GET List Themes
/wp-json/wp/v2/themes
|
|
|
|---|---|
|
`` |
Limit result set to themes assigned one or more statuses.
|
|
`` |
Scope under which the request is made; determines fields present in response. |
|
`` |
Current page of the collection.
|
|
`` |
Maximum number of items to be returned in result set.
|
|
`` |
Limit results to those matching a string. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Post status to filter by, such as 'publish', 'draft', or 'pending'. |
|
|
The response format expected from the API (e.g. application/json). |
Types (2)
GET List Types
/wp-json/wp/v2/types
|
|
|
|---|---|
|
`` |
Scope under which the request is made; determines fields present in response.
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a Type
/wp-json/wp/v2/types/{typeId}
|
|
|
|---|---|
|
`` |
An alphanumeric identifier for the post type.
|
|
`` |
Scope under which the request is made; determines fields present in response.
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
A query parameter to specify the type if needed; leave blank to use the path parameter. |
|
|
The identifier (slug) of the content type to retrieve, for example "post" or "page". |
|
|
The response format expected from the API (e.g. application/json). |
Users (8)
POST Create a User
/wp-json/wp/v2/users
|
|
|
|---|---|
|
`` |
Login name for the user.
|
|
`` |
Display name for the user. |
|
`` |
First name for the user. |
|
`` |
Last name for the user. |
|
`` |
The email address for the user.
|
|
`` |
URL of the user. |
|
`` |
Description of the user. |
|
`` |
Locale for the user.
|
|
`` |
The nickname for the user. |
|
`` |
An alphanumeric identifier for the user. |
|
`` |
Roles assigned to the user. |
|
`` |
Password for the user (never included).
|
|
`` |
Meta fields. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete Me
/wp-json/wp/v2/users/me
|
|
|
|---|---|
|
`` |
Required to be true, as users do not support trashing. |
|
`` |
Reassign the deleted user's posts and links to this user ID.
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete User
/wp-json/wp/v2/users/{userId}
|
|
|
|---|---|
|
`` |
Unique identifier for the user. |
|
`` |
Required to be true, as users do not support trashing. |
|
`` |
Reassign the deleted user's posts and links to this user ID.
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The numeric identifier of the user to delete. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Users
/wp-json/wp/v2/users
|||
|:--|:--
|``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.
|``exclude``|Ensure result set excludes specific IDs.
|``include``|Limit result set to specific IDs.
|``offset``|Offset the result set by a specific number of items.
|``order``|Order sort attribute ascending or descending.
Default: asc
One of: asc, desc
|``orderby``|Sort collection by object attribute.
Default: name
One of: id, include, name, registered_date, slug, include_slugs, email, url
|``slug``|Limit result set to users with one or more specific slugs.
|``roles``|Limit result set to users matching at least one specific role provided. Accepts csv list or single role.
|``who``|Limit result set to users who are considered authors.
One of: authors
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a Me
/wp-json/wp/v2/users/me
|
|
|
|---|---|
|
`` |
Scope under which the request is made; determines fields present in response.
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a User
/wp-json/wp/v2/users/{userId}
|
|
|
|---|---|
|
`` |
Unique identifier for the user. |
|
`` |
Scope under which the request is made; determines fields present in response.
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The numeric identifier of the user to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update Me
/wp-json/wp/v2/users/me
|
|
|
|---|---|
|
`` |
Login name for the user. |
|
`` |
Display name for the user. |
|
`` |
First name for the user. |
|
`` |
Last name for the user. |
|
`` |
The email address for the user. |
|
`` |
URL of the user. |
|
`` |
Description of the user. |
|
`` |
Locale for the user.
|
|
`` |
The nickname for the user. |
|
`` |
An alphanumeric identifier for the user. |
|
`` |
Roles assigned to the user. |
|
`` |
Password for the user (never included). |
|
`` |
Meta fields. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update a User
/wp-json/wp/v2/users/{userId}
|
|
|
|---|---|
|
`` |
Unique identifier for the user. |
|
`` |
Login name for the user. |
|
`` |
Display name for the user. |
|
`` |
First name for the user. |
|
`` |
Last name for the user. |
|
`` |
The email address for the user. |
|
`` |
URL of the user. |
|
`` |
Description of the user. |
|
`` |
Locale for the user.
|
|
`` |
The nickname for the user. |
|
`` |
An alphanumeric identifier for the user. |
|
`` |
Roles assigned to the user. |
|
`` |
Password for the user (never included). |
|
`` |
Meta fields. |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The numeric identifier of the user to update. |
|
|
The response format expected from the API (e.g. application/json). |