Version 1
Connector Overview: This page documents all 64 endpoints for the Wordpressconnector v1.
GET
Block Renderer: Retrieve a Rendered-block
|||
|:---|:---
|``name``|Unique registered name for the block.
|``context``|Scope under which the request is made; determines fields present in response.
Default: view
One of: edit
|``attributes``|Attributes for core/tag-cloud block
|``post_id``|ID of the post context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Block Revisions: Create a wp_block-revision
|||
|:--|:--
|``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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Block Revisions: Retrieve a wp_block-revision
|||
|:---|:---
|``parent``|The ID for the parent of the object.
Request:1
|``context`|Scope under which the request is made; |`determines``|fields present in response.
Default: view
One of: view, embed, edit
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Block Revisions: Retrieve a wp_block-revision with parent
|||
|:---|:---
|``parent``|The ID for the parent of the object.
|``id``|The ID 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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Blocks: Create a wp_block
| | |
| :--- | :---
|``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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Blocks: Delete a wp_block
|||
|:---|:---
|``id``|Unique identifier for the object.
|``force``|Whether to bypass trash and force deletion.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Blocks: List wp_blocks
| | |
| :--- | :---
|``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 posts published after a given ISO8601 compliant date.
|``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.
|``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
|``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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Blocks: Retrieve a wp_block
|||
|:---|:---
|``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
|``password``|The password for the post if it is password protected.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Blocks: Updating a wp_block
|||
|:---|:---
|``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
|``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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Categories: Create a category
|||
|:---|:---
|``description``|HTML description of the term.
|``name``|HTML title for the term.
Required: 1
|``slug``|An alphanumeric identifier for the term unique to its type.
|``parent``|The parent term ID.
|``meta``|Meta fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Categories: Delete a Category
|||
|:---|:---
|``id``|Unique identifier for the term.
|``force``|Required to be true, as terms do not support trashing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Categories: List 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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Categories: Retrieve a Category
|||
|:---|:---
|``id``|Unique identifier for the term.
|``context``|Scope under which the request is made; determines fields present in response.
Default: view
One of: view, embed, edit
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Categories: Update a Category
|||
|:---|:---
|``id``|Unique identifier for the term.
|``description``|HTML description of the term.
|``name``|HTML title for the term.
|``slug``|An alphanumeric identifier for the term unique to its type.
|``parent``|The parent term ID.
|``meta``|Meta fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Comments: Create a Comment
|||
|:---|:---
|``post``|The ID of the associated post object.
Required:1
|``content``|The content for the object.
Required:1
|``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, in the site's timezone.
|``date_gmt``|The date the object was published, as GMT.
|``parent``|The ID for the parent of the object.
|``status``|State of the object.
|``meta``|Meta fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Comments: Delete a Comment
|||
|:---|:---
|``id``|Unique identifier for the object.
|``force``|Whether to bypass trash and force deletion.
|``password``|The password for the parent post of the comment (if the post is password protected).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Comments: List Comments
|||
|:---|:---
|``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 specific author email. Requires authorization.
|``before``| Limit response to comments published before a given ISO8601 compliant date.
|``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_gmt
One of: date, date_gmt, id, include, post, parent, type
|``parent``|Limit result set to comments of specific parent IDs.
|``parent_exclude``|Ensure result set excludes specific parent IDs.
|``post``|Limit result set to comments assigned to specific post IDs.
|``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.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Comments: Retrieve a Comment
Authentication Required
|||
|:---|:---
|``id``|Unique identifier for the object.
|``context``|Scope under which the request is made; determines fields present inresponse.
Default:view
One of: view, embed, edit
|``password``|The password for the parent post of the comment (if the post is password protected).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Comments: Update a Comment
|||
|:---|:---
|``id``|Unique identifier for the object.
|``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, in the site's timezone.
|``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.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Media: Create a Media item
|||
|:--|:--
|``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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Media: Delete a Media item
|||
|:--|:--
|``id``|Unique identifier for the object.
|``force``|Whether to bypass trash and force deletion.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Media: List Media
|||
|:---|:---
|``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 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.
|``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
|``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: inherit
|``media_type``|Limit result set to attachments of a particular media type.
One of: image, video, audio, application
|``mime_type``|Limit result set to attachments of a particular MIME type.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Media: Retrieve a Media item
|||
|:--|:--
|``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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Media: Update a Media item
|||
|:--|:--
|``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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Misc: Google Sheet Data
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Misc: New Request
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Misc: Post Tip
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Misc: Routes
Returns all the available API routes and endpoints for a Wordpress instance.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Pages: Create a Page
|||
|:---|:---
|``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.
|``parent``|The ID for the parent of the object.
|``title``|The title for the object.
|``content``|The content for the object.
|``author``|The ID for the author of the object.
|``excerpt``|The excerpt for the object.
|``featured_media``|The ID of the featured media for 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
|``menu_order``|The order of the object in relation to other object of its type.
|``meta``|Meta fields.
|``template``|The theme file to use to display the object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Pages: Delete a Page
|||
|:--|:--
|``id``|Unique identifier for the object.
|``force``|Whether to bypass trash and force deletion.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Pages: List Pages
|||
|:---|:---
|``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 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.
|``efore``|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.
|``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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Pages: Retrieve a Page
|||
|:---|:---
|``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
|``password``|The password for the post if it is password protected.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Pages: Update a Page
|||
|:---|:---
|``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
|``password``|A password to protect access to the content and excerpt.
|``parent``|The ID for the parent of the object.
|``title``|The title for the object.
|``content``|The content for the object.
|``author``|The ID for the author of the object.
|``excerpt``|The excerpt for the object.
|``featured_media``|The ID of the featured media for 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
|``menu_order``|The order of the object in relation to other object of its type.
|``meta``|Meta fields.
|``template``|The theme file to use to display the object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Post Revisions: Delete a Post-revision
| | |
| :--- | :--
|``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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Post Revisions: List Post 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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Post Revisions: Retrieve a Post-Revision
| | |
|:--|:--
|``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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Posts: Create Posts
| | |
| :--- | :---
|``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.
|``author``|The ID for the author of the object.
|``excerpt``|The excerpt for the object.
|``featured_media``|The ID of the featured media for 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
|``format``|The format for the object.
One of: standard, aside, chat, gallery, link, image, quote, status, video, audio
|``meta``|Meta fields.
|``sticky``|Whether or not the object should be treated as sticky.
|``template``|The theme file to use to display the object.
|``categories``|The terms assigned to the object in the category taxonomy.
|``tags``|The terms assigned to the object in the post_tag taxonomy.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Posts: Delete a Post
| | |
| :--- | :---
|``id``|Unique identifier for the object.
|``force``|Whether to bypass trash and force deletion.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Posts: List 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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Posts: Retrieve a Post
| | |
| :--- | :---
|``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
|``password``|The password for the post if it is password protected.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Posts: Update a Post
|||
|:---|:---
|``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
|``password``|A password to protect access to the content and excerpt.
|``title``|The title for the object.
|``content``|The content for the object.
|``author``|The ID for the author of the object.
|``excerpt``|The excerpt for the object.
|``featured_media``|The ID of the featured media for 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
|``format``|The format for the object.
One of: standard, aside, chat, gallery, link, image, quote, status, video, audio
|``meta``|Meta fields.
|``sticky``|Whether or not the object should be treated as sticky.
|``template``|The theme file to use to display the object.
|``categories``|The terms assigned to the object in the category taxonomy.
|``tags``|The terms assigned to the object in the post_tag taxonomy.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Search Results: List Search-results
|||
|:---|:---
|``context``|Scope under which the request is made; determines fields present in response.
Default: view
One of: view, embed
|``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.
|``type``|Limit results to items of an object type.
Default: post
One of: post
|``subtype``|Limit results to items of one or more object subtypes.
Default: any
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Settings: Retrieve Site Settings
There are no arguments for this endpoint.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Settings: Update Site Settings
|||
|:---|:---
|``title``|Site title.
|``description``|Site tagline.
|``timezone``|A city in the same timezone as you.
|``date_format``|A date format for all date strings.
|``time_format``|A time format for all time strings.
|``start_of_week``|A day number of the week that the week should start on.
|``language``|WordPress locale code.
|``use_smilies``|Convert emoticons like :-) and :-P to graphics on display.
|``default_category``|Default post category.
|``default_post_format``|Default post format.
|``posts_per_page``|Blog pages show at most.
|``default_ping_status``|Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.
One of: open, closed
|``default_comment_status``|Allow people to post comments on new articles.
One of: open, closed
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Statuses: Retrieve a Status
|||
|:---|:---
|``context``|Scope under which the request is made; determines fields present in response.
Default: view
One of: view, embed, ed
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Statuses: Retrieve a Status
|||
|:---|:---
|``status``|An alphanumeric identifier for the status.
|``context``|Scope under which the request is made; determines fields present in response.
Default: view
One of: view, embed, edit
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Tags: Create a Tag
|||
|:---|:---
|``description``|HTML description of the term.
|``name``|HTML title for the term.
Required: 1
|``slug``|An alphanumeric identifier for the term unique to its type.
|``meta``|Meta fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Tags: Delete a Tag
|||
|:---|:---
|``id``|Unique identifier for the term.
|``force``|Required to be true, as terms do not support trashing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Tags: List 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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Tags: Retrieve a Tag
|||
|:---|:---
|``id``|Unique identifier for the term.
|``context`|Scope under which the request is made; |`determines``|fields present in response.
Default: view
One of: view, embed, edit
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Tags: Update a Tag
|||
|:---|:---
|``id``|Unique identifier for the term.
|``description``|HTML description of the term.
|``name``|HTML title for the term.
|``slug``|An alphanumeric identifier for the term unique to its type.
|``meta``|Meta fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Taxonomies: Retrieve a Taxonomy
|||
|:---|:---
|``context``|Scope under which the request is made; determines fields present in response.
Default: view
One of: view, embed, edit
|``type``|Limit results to taxonomies associated with a specific post type.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Taxonomies: Retrieve a 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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Themes: List Themes
|||
|:---|:---
|``status``|Limit result set to themes assigned one or more statuses.
Required: 1
|``context``|Scope under which the request is made; determines fields present in response.
|``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.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Types: List Types
|||
|:---|:---
|``context``|Scope under which the request is made; determines fields present in response.
Default: view
One of: view, embed, edit
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Types: Retrieve a Type
|||
|:---|:---
|``type``|An alphanumeric identifier for the post type.
Required:1
|``context``|Scope under which the request is made; determines fields present in response.
Default: view
One of: view, embed, edit
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Users: Create a User
|||
|:---|:---
|``username``|Login name for the user.
Required: 1
|``name``|Display name for the user.
|``first_name``|First name for the user.
|``last_name``|Last name for the user.
|``email``|The email address for the user.
Required: 1
|``url``|URL of the user.
|``description``|Description of the user.
|``locale``|Locale for the user.
One of: en_US
|``nickname``|The nickname for the user.
|``slug``|An alphanumeric identifier for the user.
|``roles``|Roles assigned to the user.
|``password``|Password for the user (never included).
Required: 1
|``meta``|Meta fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Users: Delete Me
|||
|:---|:---
|``force``|Required to be true, as users do not support trashing.
|``reassign``|Reassign the deleted user's posts and links to this user ID.
Required: 1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Users: Delete User
|||
|:---|:---
|``id``|Unique identifier for the user.
|``force``|Required to be true, as users do not support trashing.
|``reassign``|Reassign the deleted user's posts and links to this user ID.
Required: 1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Users: List 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 |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Users: Retrieve a Me
|||
|:---|:---
|``context``|Scope under which the request is made; determines fields present in response.
Default: view
One of: view, embed, edit
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Users: Retrieve a User
|||
|:---|:---
|``id``|Unique identifier for the user.
|``context``|Scope under which the request is made; determines fields present in response.
Default: view
One of: view, embed, edit
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Users: Update Me
|||
|:---|:---
|``username``|Login name for the user.
|``name``|Display name for the user.
|``first_name``|First name for the user.
|``last_name``|Last name for the user.
|``email``|The email address for the user.
|``url``|URL of the user.
|``description``|Description of the user.
|``locale``|Locale for the user.
One of: en_US
|``nickname``|The nickname for the user.
|``slug``|An alphanumeric identifier for the user.
|``roles``|Roles assigned to the user.
|``password``|Password for the user (never included).
|``meta``|Meta fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Users: Update a User
|||
|:---|:---
|``id``|Unique identifier for the user.
|``username``|Login name for the user.
|``name``|Display name for the user.
|``first_name``|First name for the user.
|``last_name``|Last name for the user.
|``email``|The email address for the user.
|``url``|URL of the user.
|``description``|Description of the user.
|``locale``|Locale for the user.
One of: en_US
|``nickname``|The nickname for the user.
|``slug``|An alphanumeric identifier for the user.
|``roles``|Roles assigned to the user.
|``password``|Password for the user (never included).
|``meta``|Meta fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |