Wordpressconnector v1

Version 1

Connector Overview: This page documents all 64 actions for the Wordpressconnector v1.

Block Renderer

GET Retrieve a Rendered-block

/wp-json/wp/v2/block-renderer/{blockName}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Blockname

N/A

Response Type

N/A

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Blockid

N/A

Response Type

N/A

GET Retrieve a wp_block-revision

/wp-json/wp/v2/blocks/{blockId}/autosaves





``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Parent

N/A

Blockid

N/A

Response Type

N/A

GET Retrieve a wp_block-revision with parent

/wp-json/wp/v2/blocks/{parentId}/autosaves/{blockId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Parentid

N/A

Blockid

N/A

Response Type

N/A

Blocks (5)

POST Create a wp_block

/wp-json/wp/v2/blocks



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Title

N/A

Content

N/A

Response Type

N/A

DELETE Delete a wp_block

/wp-json/wp/v2/blocks/{blockId}



``id``

Unique identifier for the object.

``force``

Whether to bypass trash and force deletion.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Force

N/A

Blockid

N/A

Response Type

N/A

GET List wp_blocks

/wp-json/wp/v2/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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

GET Retrieve a wp_block

/wp-json/wp/v2/blocks/{blockId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Blockid

N/A

Response Type

N/A

POST Updating a wp_block

/wp-json/wp/v2/blocks/{blockId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Content

N/A

Title

N/A

Blockid

N/A

Response Type

N/A

Categories (5)

POST Create a category

/wp-json/wp/v2/categories



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Name

N/A

Response Type

N/A

DELETE Delete a Category

/wp-json/wp/v2/categories/{categoriesId}



``id``

Unique identifier for the term.

``force``

Required to be true, as terms do not support trashing.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Force

N/A

Categoriesid

N/A

Response Type

N/A

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

GET Retrieve a Category

/wp-json/wp/v2/categories/{categoriesId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Categoriesid

N/A

Response Type

N/A

POST Update a Category

/wp-json/wp/v2/categories/{categoriesId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Name

N/A

Categoriesid

N/A

Response Type

N/A

Comments (5)

POST Create a Comment

/wp-json/wp/v2/comments



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Post

N/A

Content

N/A

Author Name

N/A

Author Email

N/A

Response Type

N/A

DELETE Delete a Comment

/wp-json/wp/v2/comments/{commentId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Commentid

N/A

Response Type

N/A

GET List Comments

/wp-json/wp/v2/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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

GET Retrieve a Comment

/wp-json/wp/v2/comments/{commentId}

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Commentid

N/A

Response Type

N/A

POST Update a Comment

/ /wp-json/wp/v2/comments/{commentId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Content

N/A

Commentid

N/A

Response Type

N/A

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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

Options (1)

Option Name

Description

File

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Force

N/A

Mediaid

N/A

Response Type

N/A

GET List Media

/wp-json/wp/v2/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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Mediaid

N/A

Response Type

N/A

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Caption

N/A

Mediaid

N/A

Response Type

N/A

Misc (4)

GET Google Sheet Data

/integromat!A2:A3

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Key

N/A

Response Type

N/A

POST New Request

/

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Wpwhpro Action

N/A

Wpwhpro Api Key

N/A

Action

N/A

Post Author

N/A

Post Title

N/A

Response Type

N/A

POST Post Tip

/Dr3OQkjzY3fdNNEwe8x7

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Value1

N/A

Value2

N/A

Response Type

N/A

GET Routes

/wp-json

Returns all the available API routes and endpoints for a Wordpress instance.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

Pages (5)

POST Create a Page

/wp-json/wp/v2/pages



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Content

N/A

Title

N/A

Excerpt

N/A

Response Type

N/A

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Pageid

N/A

Response Type

N/A

GET List Pages

/wp-json/wp/v2/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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

GET Retrieve a Page

/wp-json/wp/v2/pages/{pageId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Pageid

N/A

Response Type

N/A

POST Update a Page

/wp-json/wp/v2/pages/{pageId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Title

N/A

Content

N/A

Excerpt

N/A

Pageid

N/A

Response Type

N/A

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Parentid

N/A

Revisionsid

N/A

Response Type

N/A

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Postid

N/A

Response Type

N/A

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Parentid

N/A

Revisionid

N/A

Response Type

N/A

Posts (5)

POST Create Posts

/wp-json/wp/v2/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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

Options (2)

Option Name

Description

Title

N/A

Content

N/A

DELETE Delete a Post

/wp-json/wp/v2/posts/{postId}



``id``

Unique identifier for the object.

``force``

Whether to bypass trash and force deletion.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Postid

N/A

Response Type

N/A

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Context

N/A

Page

N/A

Per Page

N/A

Search

N/A

After

N/A

Modified After

N/A

Author

N/A

Status

N/A

Tags

N/A

Response Type

N/A

GET Retrieve a Post

/wp-json/wp/v2/posts/{postId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Postid

N/A

Response Type

N/A

POST Update a Post

/wp-json/wp/v2/posts/{postId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Content

N/A

Title

N/A

Excerpt

N/A

Postid

N/A

Response Type

N/A

Search Results

GET List Search-results

/wp-json/wp/v2/search



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

Settings (2)

GET Retrieve Site Settings

/wp-json/wp/v2/settings

There are no arguments for this endpoint.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

POST Update Site Settings

/wp-json/wp/v2/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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

Statuses (2)

GET Retrieve a Status

/wp-json/wp/v2/statuses



``context``

Scope under which the request is made; determines fields present in response.
Default: view
One of: view, embed, ed

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

GET Retrieve a Status

/wp-json/wp/v2/statuses/{statusId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Statusid

N/A

Response Type

N/A

Tags (5)

POST Create a Tag

/wp-json/wp/v2/tags



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Name

N/A

Response Type

N/A

DELETE Delete a Tag

/wp-json/wp/v2/tags/{tagId}



``id``

Unique identifier for the term.

``force``

Required to be true, as terms do not support trashing.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Force

N/A

Tagid

N/A

Response Type

N/A

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

GET Retrieve a Tag

/wp-json/wp/v2/tags/{tagId}





``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Tagid

N/A

Response Type

N/A

POST Update a Tag

/wp-json/wp/v2/tags/{tagId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Name

N/A

Tagid

N/A

Response Type

N/A

Taxonomies (2)

GET Retrieve a Taxonomy

/wp-json/wp/v2/taxonomies



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Taxonomy

N/A

Response Type

N/A

Themes

GET List Themes

/wp-json/wp/v2/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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Status

N/A

Response Type

N/A

Types (2)

GET List Types

/wp-json/wp/v2/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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

GET Retrieve a Type

/wp-json/wp/v2/types/{typeId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Type

N/A

Typeid

N/A

Response Type

N/A

Users (8)

POST Create a User

/wp-json/wp/v2/users



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

DELETE Delete Me

/wp-json/wp/v2/users/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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

DELETE Delete User

/wp-json/wp/v2/users/{userId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Userid

N/A

Response Type

N/A

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

GET Retrieve a Me

/wp-json/wp/v2/users/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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

GET Retrieve a User

/wp-json/wp/v2/users/{userId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Userid

N/A

Response Type

N/A

POST Update Me

/wp-json/wp/v2/users/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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

POST Update a User

/wp-json/wp/v2/users/{userId}



``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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Userid

N/A

Response Type

N/A