Skip to content

WordPress Operations Reference

This page covers the parameters and expected output for each operation available in the WordPress integration.

Get Me

Get the current authenticated user profile in WordPress.

This operation has no input parameters.

Parameter Description
ID The unique ID of the authenticated user.
username The username of the authenticated user.
email The email address of the authenticated user.
displayName The display name of the authenticated user.

Create Post

Create a new post or page in WordPress.

Parameter Description Type Required/Optional
Type The content type. Supported values:
  • post (default)
  • page
 string Optional.
Title The title of the post or page. string Required.
Content The content of the post or page. HTML is supported. string Required.
Status The post status. Supported values:
  • draft (default)
  • publish
  • pending
  • private
 string Optional.
Excerpt The post excerpt. string Optional.
Categories The category names or IDs, entered as comma-separated values. Applicable to posts only. string Optional.
Tags The tag names or IDs, entered as comma-separated values. Applicable to posts only. string Optional.
Featured Media The media ID of the featured image.
To get the media ID, open the media item in the WordPress admin panel. The ID is the value of the item parameter in the URL: https://<YOUR-SITE>/wp-admin/upload.php?item=<MEDIA-ID>.		 integer Optional.
Parent The ID of the parent page. Used to nest the new page under an existing page, supporting multi-level hierarchies. Applicable to pages only. integer Optional.
Menu Order The menu order of the page. Applicable to pages only. integer Optional.

Returns a full WordPress post object containing all post fields.

Update Post

Update an existing post or page in WordPress. It cannot update the type, which means it can't change a page to a post and vice versa.

Parameter Description Type Required/Optional
Post Id The ID of the post or page to update.
To get the post ID, open the post or page in the WordPress admin panel. The ID is the value of the post parameter in the URL: https://<YOUR-SITE>/wp-admin/post.php?post=<POST-ID>&action=edit.		 integer Required.
Title The updated title of the post or page. string Optional.
Content The updated content of the post or page. HTML is supported. string Required.
Status The updated post status. Supported values:
  • draft
  • publish
  • pending
  • private
 string Optional.
Excerpt The updated post excerpt. string Optional.
Categories The updated category names or IDs, entered as comma-separated values. Applicable to posts only. string Optional.
Tags The updated tag names or IDs, entered as comma-separated values. Applicable to posts only. string Optional.
Featured Media The updated media ID of the featured image.
To get the media ID, open the media item in the WordPress admin panel. The ID is the value of the item parameter in the URL: https://<YOUR-SITE>/wp-admin/upload.php?item=<MEDIA-ID>.		 integer Optional.
Parent The ID of an existing published page to set as the parent. When updated, the page is moved under the specified parent in the hierarchy. Applicable to pages only. integer Optional.
Menu Order The updated menu order of the page. Applicable to pages only. integer Optional.

Note

In addition to the mandatory field Post ID, at least one other field must also be provided for the operation to work.

Returns a full WordPress post object containing all post fields.

Delete Post

Delete a post or page by ID. The post or page is moved to trash and can be recovered from the WordPress admin panel.

Parameter Description Type Required/Optional
Post id The ID of the post or page to delete.
To get the post ID, open the post or page in the WordPress admin panel. The ID is the value of the post parameter in the URL: https://<YOUR-SITE>/wp-admin/post.php?post=<POST-ID>&action=edit.		 integer Required.
Type The content type for validation. Supported values:
  • post
  • page
 string Optional.

Returns a full WordPress post object containing all post fields.

Get Post

Get a specific post or page by ID.

Parameter Description Type Required/Optional
Post id The ID of the post or page to retrieve.
To get the post ID, open the post or page in the WordPress admin panel. The ID is the value of the post parameter in the URL: https://<YOUR-SITE>/wp-admin/post.php?post=<POST-ID>&action=edit.		 integer Required.
Type The content type for validation. Supported values:
  • post
  • page
 string Optional.

Returns a full WordPress post object containing all post fields.

List Posts

List posts or pages with optional filters.

Parameter Description Type Required/Optional
Type The type to filter. Supported values:
  • page
  • post
 string Optional.
Per Page The number of items to return per page. Maximum value is 100. Default is 20. integer Optional.
Page The page number for pagination. Default is 1. integer Optional.
Status The status to filter. Supported values:
  • publish
  • draft
  • pending
  • private
  • any (default)
 string Optional.
Search The search term. string Optional.
Order By Sort field. Supported values:
  • date
  • modified (default)
  • title
 string Optional.
Order The sorting order. Supported values:
  • ASC
  • DESC (default)
 string Optional.

Returns a list of posts or pages, including metadata such as ID, title, author, status, categories, tags, and pagination details.

List Tags

List all tags in the Wordpress site.

Parameter Description Type Required/Optional
Per Page The number of tags to return per page. Maximum value is 100. Default is 100. integer Optional.
Page The page number for pagination. Default is 1. integer Optional.
Parameter Description
data List of tags available in the WordPress site, including details such as ID, name, slug, description, post count, and related metadata.
otal Total number of tags available for the site.
totalPages Total number of pages available based on the pagination settings.
perPage Number of tags returned per page in the response.
page Current page number of the returned results.

List Categories

List all categories in the WordPress site.

Parameter Description Type Required/Optional
Per Page The number of categories to return per page. Maximum value is 100. Default is 100. integer Optional.
Page The page number for pagination. Default is 1. integer Optional.
Parameter Description
data List of categories available in the WordPress site, including details such as ID, name, slug, description, parent category, post count, feed URL, and related metadata.
total Total number of categories available for the site.
totalPages Total number of pages available based on the pagination settings.
perPage Number of categories returned per page in the response.
page Current page number of the returned results.

Upload Media

Upload a media file to WordPress from a URL.

Parameter Description Type Required/Optional
Media Url The publicly accessible URL of the media file to upload. string Required.

Returns details of the uploaded media file, including the media ID, file URL, MIME type, size, dimensions, generated thumbnails, and related metadata.

Get Media

Get a specific media item by ID.

Parameter Description Type Required/Optional
Media Id The unique identifier of the media item to retrieve.
To get the media ID, open the media item in the WordPress admin panel. The ID is the value of the item parameter in the URL: https://<YOUR-SITE>/wp-admin/upload.php?item=<MEDIA-ID>.		 integer Required.

Returns details of the uploaded media asset, including its ID, file URL, MIME type, size, dimensions, generated thumbnails, EXIF metadata, and related API links.

List Media

List all media items.

Parameter Description Type Required/Optional
Per Page The number of media items to return per page. Maximum value is 100. Default is 50. integer Optional.
Page The page number for pagination. Default is 1. integer Optional.
Parameter Description
data List of media files available in the WordPress site, including details such as media ID, file URL, MIME type, size, dimensions, thumbnails, EXIF metadata, and related links.
total Total number of media items available for the site.
totalPages Total number of pages available based on the pagination settings.
perPage Number of media items returned per page in the response.
page Current page number of the returned results.