WordPress

WordPress.com hosts sites and their content. Connect a WordPress.com site through OAuth to create and manage posts, pages, media, comments, categories, tags, and users. Use the search operation to find content before reading or updating it.

Usage Instructions

Integrate with WordPress.com to create, update, and manage posts, pages, media, comments, categories, tags, and users. Connects to WordPress.com sites via OAuth.

Actions

WordPress Create Post

Create a new blog post in WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
titlestringYesPost title
contentstringNoPost content (HTML or plain text)
statusstringNoPost status: publish, draft, pending, private, or future
excerptstringNoPost excerpt
categoriesstringNoComma-separated category IDs
tagsstringNoComma-separated tag IDs
featuredMedianumberNoFeatured image media ID
slugstringNoURL slug for the post

Output

ParameterTypeDescription
postobjectThe created post
↳ idnumberPost ID
↳ datestringPost creation date
↳ modifiedstringPost modification date
↳ slugstringPost slug
↳ statusstringPost status
↳ typestringPost type
↳ linkstringPost URL
↳ titleobjectPost title object
↳ contentobjectPost content object
↳ excerptobjectPost excerpt object
↳ authornumberAuthor ID
↳ featured_medianumberFeatured media ID
↳ categoriesarrayCategory IDs
↳ tagsarrayTag IDs

WordPress Update Post

Update an existing blog post in WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
postIdnumberYesThe ID of the post to update
titlestringNoPost title
contentstringNoPost content (HTML or plain text)
statusstringNoPost status: publish, draft, pending, private, or future
excerptstringNoPost excerpt
categoriesstringNoComma-separated category IDs
tagsstringNoComma-separated tag IDs
featuredMedianumberNoFeatured image media ID
slugstringNoURL slug for the post

Output

ParameterTypeDescription
postobjectThe updated post
↳ idnumberPost ID
↳ datestringPost creation date
↳ modifiedstringPost modification date
↳ slugstringPost slug
↳ statusstringPost status
↳ typestringPost type
↳ linkstringPost URL
↳ titleobjectPost title object
↳ contentobjectPost content object
↳ excerptobjectPost excerpt object
↳ authornumberAuthor ID
↳ featured_medianumberFeatured media ID
↳ categoriesarrayCategory IDs
↳ tagsarrayTag IDs

WordPress Delete Post

Delete a blog post from WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
postIdnumberYesThe ID of the post to delete
forcebooleanNoBypass trash and force delete permanently

Output

ParameterTypeDescription
deletedbooleanWhether the post was deleted
postobjectThe deleted post
↳ idnumberPost ID
↳ datestringPost creation date
↳ modifiedstringPost modification date
↳ slugstringPost slug
↳ statusstringPost status
↳ typestringPost type
↳ linkstringPost URL
↳ titleobjectPost title object
↳ contentobjectPost content object
↳ excerptobjectPost excerpt object
↳ authornumberAuthor ID
↳ featured_medianumberFeatured media ID
↳ categoriesarrayCategory IDs
↳ tagsarrayTag IDs

WordPress Get Post

Get a single blog post from WordPress.com by ID

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
postIdnumberYesThe ID of the post to retrieve

Output

ParameterTypeDescription
postobjectThe retrieved post
↳ idnumberPost ID
↳ datestringPost creation date
↳ modifiedstringPost modification date
↳ slugstringPost slug
↳ statusstringPost status
↳ typestringPost type
↳ linkstringPost URL
↳ titleobjectPost title object
↳ contentobjectPost content object
↳ excerptobjectPost excerpt object
↳ authornumberAuthor ID
↳ featured_medianumberFeatured media ID
↳ categoriesarrayCategory IDs
↳ tagsarrayTag IDs

WordPress List Posts

List blog posts from WordPress.com with optional filters

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
perPagenumberNoNumber of posts per page (e.g., 10, 25, 50). Default: 10, max: 100
pagenumberNoPage number for pagination (e.g., 1, 2, 3)
statusstringNoPost status filter: publish, draft, pending, private
authornumberNoFilter by author ID (e.g., 1, 42)
categoriesstringNoComma-separated category IDs to filter by (e.g., "1,2,3")
tagsstringNoComma-separated tag IDs to filter by (e.g., "5,10,15")
searchstringNoSearch term to filter posts (e.g., "tutorial", "announcement")
orderBystringNoOrder by field: date, id, title, slug, modified
orderstringNoOrder direction: asc or desc

Output

ParameterTypeDescription
postsarrayList of posts
↳ idnumberPost ID
↳ datestringPost creation date
↳ modifiedstringPost modification date
↳ slugstringPost slug
↳ statusstringPost status
↳ typestringPost type
↳ linkstringPost URL
↳ titleobjectPost title object
↳ contentobjectPost content object
↳ excerptobjectPost excerpt object
↳ authornumberAuthor ID
↳ featured_medianumberFeatured media ID
↳ categoriesarrayCategory IDs
↳ tagsarrayTag IDs
totalnumberTotal number of posts
totalPagesnumberTotal number of pages

WordPress Create Page

Create a new page in WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
titlestringYesPage title
contentstringNoPage content (HTML or plain text)
statusstringNoPage status: publish, draft, pending, private
excerptstringNoPage excerpt
parentnumberNoParent page ID for hierarchical pages
menuOrdernumberNoOrder in page menu
featuredMedianumberNoFeatured image media ID
slugstringNoURL slug for the page

Output

ParameterTypeDescription
pageobjectThe created page
↳ idnumberPage ID
↳ datestringPage creation date
↳ modifiedstringPage modification date
↳ slugstringPage slug
↳ statusstringPage status
↳ typestringContent type
↳ linkstringPage URL
↳ titleobjectPage title object
↳ contentobjectPage content object
↳ excerptobjectPage excerpt object
↳ authornumberAuthor ID
↳ featured_medianumberFeatured media ID
↳ parentnumberParent page ID
↳ menu_ordernumberMenu order

WordPress Update Page

Update an existing page in WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
pageIdnumberYesThe ID of the page to update
titlestringNoPage title
contentstringNoPage content (HTML or plain text)
statusstringNoPage status: publish, draft, pending, private
excerptstringNoPage excerpt
parentnumberNoParent page ID for hierarchical pages
menuOrdernumberNoOrder in page menu
featuredMedianumberNoFeatured image media ID
slugstringNoURL slug for the page

Output

ParameterTypeDescription
pageobjectThe updated page
↳ idnumberPage ID
↳ datestringPage creation date
↳ modifiedstringPage modification date
↳ slugstringPage slug
↳ statusstringPage status
↳ typestringContent type
↳ linkstringPage URL
↳ titleobjectPage title object
↳ contentobjectPage content object
↳ excerptobjectPage excerpt object
↳ authornumberAuthor ID
↳ featured_medianumberFeatured media ID
↳ parentnumberParent page ID
↳ menu_ordernumberMenu order

WordPress Delete Page

Delete a page from WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
pageIdnumberYesThe ID of the page to delete
forcebooleanNoBypass trash and force delete permanently

Output

ParameterTypeDescription
deletedbooleanWhether the page was deleted
pageobjectThe deleted page
↳ idnumberPage ID
↳ datestringPage creation date
↳ modifiedstringPage modification date
↳ slugstringPage slug
↳ statusstringPage status
↳ typestringContent type
↳ linkstringPage URL
↳ titleobjectPage title object
↳ contentobjectPage content object
↳ excerptobjectPage excerpt object
↳ authornumberAuthor ID
↳ featured_medianumberFeatured media ID
↳ parentnumberParent page ID
↳ menu_ordernumberMenu order

WordPress Get Page

Get a single page from WordPress.com by ID

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
pageIdnumberYesThe ID of the page to retrieve

Output

ParameterTypeDescription
pageobjectThe retrieved page
↳ idnumberPage ID
↳ datestringPage creation date
↳ modifiedstringPage modification date
↳ slugstringPage slug
↳ statusstringPage status
↳ typestringContent type
↳ linkstringPage URL
↳ titleobjectPage title object
↳ contentobjectPage content object
↳ excerptobjectPage excerpt object
↳ authornumberAuthor ID
↳ featured_medianumberFeatured media ID
↳ parentnumberParent page ID
↳ menu_ordernumberMenu order

WordPress List Pages

List pages from WordPress.com with optional filters

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
perPagenumberNoNumber of pages per request (e.g., 10, 25, 50). Default: 10, max: 100
pagenumberNoPage number for pagination (e.g., 1, 2, 3)
statusstringNoPage status filter: publish, draft, pending, private
parentnumberNoFilter by parent page ID (e.g., 123)
searchstringNoSearch term to filter pages (e.g., "about", "contact")
orderBystringNoOrder by field: date, id, title, slug, modified, menu_order
orderstringNoOrder direction: asc or desc

Output

ParameterTypeDescription
pagesarrayList of pages
↳ idnumberPage ID
↳ datestringPage creation date
↳ modifiedstringPage modification date
↳ slugstringPage slug
↳ statusstringPage status
↳ typestringContent type
↳ linkstringPage URL
↳ titleobjectPage title object
↳ contentobjectPage content object
↳ excerptobjectPage excerpt object
↳ authornumberAuthor ID
↳ featured_medianumberFeatured media ID
↳ parentnumberParent page ID
↳ menu_ordernumberMenu order
totalnumberTotal number of pages
totalPagesnumberTotal number of result pages

WordPress Upload Media

Upload a media file (image, video, document) to WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
filefileNoFile to upload (UserFile object)
filenamestringNoOptional filename override (e.g., image.jpg)
titlestringNoMedia title
captionstringNoMedia caption
altTextstringNoAlternative text for accessibility
descriptionstringNoMedia description

Output

ParameterTypeDescription
mediaobjectThe uploaded media item
↳ idnumberMedia ID
↳ datestringUpload date
↳ slugstringMedia slug
↳ typestringContent type
↳ linkstringMedia page URL
↳ titleobjectMedia title object
↳ captionobjectMedia caption object
↳ alt_textstringAlt text
↳ media_typestringMedia type (image, video, etc.)
↳ mime_typestringMIME type
↳ source_urlstringDirect URL to the media file
↳ media_detailsobjectMedia details (dimensions, etc.)

WordPress Get Media

Get a single media item from WordPress.com by ID

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
mediaIdnumberYesThe ID of the media item to retrieve

Output

ParameterTypeDescription
mediaobjectThe retrieved media item
↳ idnumberMedia ID
↳ datestringUpload date
↳ slugstringMedia slug
↳ typestringContent type
↳ linkstringMedia page URL
↳ titleobjectMedia title object
↳ captionobjectMedia caption object
↳ alt_textstringAlt text
↳ media_typestringMedia type (image, video, etc.)
↳ mime_typestringMIME type
↳ source_urlstringDirect URL to the media file
↳ media_detailsobjectMedia details (dimensions, etc.)

WordPress List Media

List media items from the WordPress.com media library

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
perPagenumberNoNumber of media items per request (e.g., 10, 25, 50). Default: 10, max: 100
pagenumberNoPage number for pagination (e.g., 1, 2, 3)
searchstringNoSearch term to filter media (e.g., "logo", "banner")
mediaTypestringNoFilter by media type: image, video, audio, application
mimeTypestringNoFilter by specific MIME type (e.g., image/jpeg, image/png)
orderBystringNoOrder by field: date, id, title, slug
orderstringNoOrder direction: asc or desc

Output

ParameterTypeDescription
mediaarrayList of media items
↳ idnumberMedia ID
↳ datestringUpload date
↳ slugstringMedia slug
↳ typestringContent type
↳ linkstringMedia page URL
↳ titleobjectMedia title object
↳ captionobjectMedia caption object
↳ alt_textstringAlt text
↳ media_typestringMedia type (image, video, etc.)
↳ mime_typestringMIME type
↳ source_urlstringDirect URL to the media file
↳ media_detailsobjectMedia details (dimensions, etc.)
totalnumberTotal number of media items
totalPagesnumberTotal number of result pages

WordPress Delete Media

Delete a media item from WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
mediaIdnumberYesThe ID of the media item to delete

Output

ParameterTypeDescription
deletedbooleanWhether the media was deleted
mediaobjectThe deleted media item
↳ idnumberMedia ID
↳ datestringUpload date
↳ slugstringMedia slug
↳ typestringContent type
↳ linkstringMedia page URL
↳ titleobjectMedia title object
↳ captionobjectMedia caption object
↳ alt_textstringAlt text
↳ media_typestringMedia type (image, video, etc.)
↳ mime_typestringMIME type
↳ source_urlstringDirect URL to the media file
↳ media_detailsobjectMedia details (dimensions, etc.)

WordPress Create Comment

Create a new comment on a WordPress.com post

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
postIdnumberYesThe ID of the post to comment on
contentstringYesComment content
parentnumberNoParent comment ID for replies
authorNamestringNoComment author display name
authorEmailstringNoComment author email
authorUrlstringNoComment author URL

Output

ParameterTypeDescription
commentobjectThe created comment
↳ idnumberComment ID
↳ postnumberPost ID
↳ parentnumberParent comment ID
↳ authornumberAuthor user ID
↳ author_namestringAuthor display name
↳ author_emailstringAuthor email
↳ author_urlstringAuthor URL
↳ datestringComment date
↳ contentobjectComment content object
↳ linkstringComment permalink
↳ statusstringComment status

WordPress List Comments

List comments from WordPress.com with optional filters

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
perPagenumberNoNumber of comments per request (e.g., 10, 25, 50). Default: 10, max: 100
pagenumberNoPage number for pagination (e.g., 1, 2, 3)
postIdnumberNoFilter by post ID (e.g., 123, 456)
statusstringNoFilter by comment status: approved, hold, spam, trash
searchstringNoSearch term to filter comments (e.g., "question", "feedback")
orderBystringNoOrder by field: date, id, parent
orderstringNoOrder direction: asc or desc

Output

ParameterTypeDescription
commentsarrayList of comments
↳ idnumberComment ID
↳ postnumberPost ID
↳ parentnumberParent comment ID
↳ authornumberAuthor user ID
↳ author_namestringAuthor display name
↳ author_emailstringAuthor email
↳ author_urlstringAuthor URL
↳ datestringComment date
↳ contentobjectComment content object
↳ linkstringComment permalink
↳ statusstringComment status
totalnumberTotal number of comments
totalPagesnumberTotal number of result pages

WordPress Update Comment

Update a comment in WordPress.com (content or status)

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
commentIdnumberYesThe ID of the comment to update
contentstringNoUpdated comment content
statusstringNoComment status: approved, hold, spam, trash

Output

ParameterTypeDescription
commentobjectThe updated comment
↳ idnumberComment ID
↳ postnumberPost ID
↳ parentnumberParent comment ID
↳ authornumberAuthor user ID
↳ author_namestringAuthor display name
↳ author_emailstringAuthor email
↳ author_urlstringAuthor URL
↳ datestringComment date
↳ contentobjectComment content object
↳ linkstringComment permalink
↳ statusstringComment status

WordPress Delete Comment

Delete a comment from WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
commentIdnumberYesThe ID of the comment to delete
forcebooleanNoBypass trash and force delete permanently

Output

ParameterTypeDescription
deletedbooleanWhether the comment was deleted
commentobjectThe deleted comment
↳ idnumberComment ID
↳ postnumberPost ID
↳ parentnumberParent comment ID
↳ authornumberAuthor user ID
↳ author_namestringAuthor display name
↳ author_emailstringAuthor email
↳ author_urlstringAuthor URL
↳ datestringComment date
↳ contentobjectComment content object
↳ linkstringComment permalink
↳ statusstringComment status

WordPress Create Category

Create a new category in WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
namestringYesCategory name
descriptionstringNoCategory description
parentnumberNoParent category ID for hierarchical categories
slugstringNoURL slug for the category

Output

ParameterTypeDescription
categoryobjectThe created category
↳ idnumberCategory ID
↳ countnumberNumber of posts in this category
↳ descriptionstringCategory description
↳ linkstringCategory archive URL
↳ namestringCategory name
↳ slugstringCategory slug
↳ taxonomystringTaxonomy name
↳ parentnumberParent category ID

WordPress List Categories

List categories from WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
perPagenumberNoNumber of categories per request (e.g., 10, 25, 50). Default: 10, max: 100
pagenumberNoPage number for pagination (e.g., 1, 2, 3)
searchstringNoSearch term to filter categories (e.g., "news", "technology")
orderstringNoOrder direction: asc or desc

Output

ParameterTypeDescription
categoriesarrayList of categories
↳ idnumberCategory ID
↳ countnumberNumber of posts in this category
↳ descriptionstringCategory description
↳ linkstringCategory archive URL
↳ namestringCategory name
↳ slugstringCategory slug
↳ taxonomystringTaxonomy name
↳ parentnumberParent category ID
totalnumberTotal number of categories
totalPagesnumberTotal number of result pages

WordPress Get Category

Get a single category from WordPress.com by ID

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
categoryIdnumberYesThe ID of the category to retrieve

Output

ParameterTypeDescription
categoryobjectThe retrieved category
↳ idnumberCategory ID
↳ countnumberNumber of posts in this category
↳ descriptionstringCategory description
↳ linkstringCategory archive URL
↳ namestringCategory name
↳ slugstringCategory slug
↳ taxonomystringTaxonomy name
↳ parentnumberParent category ID

WordPress Update Category

Update an existing category in WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
categoryIdnumberYesThe ID of the category to update
namestringNoCategory name
descriptionstringNoCategory description
parentnumberNoParent category ID for hierarchical categories
slugstringNoURL slug for the category

Output

ParameterTypeDescription
categoryobjectThe updated category
↳ idnumberCategory ID
↳ countnumberNumber of posts in this category
↳ descriptionstringCategory description
↳ linkstringCategory archive URL
↳ namestringCategory name
↳ slugstringCategory slug
↳ taxonomystringTaxonomy name
↳ parentnumberParent category ID

WordPress Delete Category

Delete a category from WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
categoryIdnumberYesThe ID of the category to delete

Output

ParameterTypeDescription
deletedbooleanWhether the category was deleted
categoryobjectThe deleted category
↳ idnumberCategory ID
↳ countnumberNumber of posts in this category
↳ descriptionstringCategory description
↳ linkstringCategory archive URL
↳ namestringCategory name
↳ slugstringCategory slug
↳ taxonomystringTaxonomy name
↳ parentnumberParent category ID

WordPress Create Tag

Create a new tag in WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
namestringYesTag name
descriptionstringNoTag description
slugstringNoURL slug for the tag

Output

ParameterTypeDescription
tagobjectThe created tag
↳ idnumberTag ID
↳ countnumberNumber of posts with this tag
↳ descriptionstringTag description
↳ linkstringTag archive URL
↳ namestringTag name
↳ slugstringTag slug
↳ taxonomystringTaxonomy name

WordPress List Tags

List tags from WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
perPagenumberNoNumber of tags per request (e.g., 10, 25, 50). Default: 10, max: 100
pagenumberNoPage number for pagination (e.g., 1, 2, 3)
searchstringNoSearch term to filter tags (e.g., "javascript", "tutorial")
orderstringNoOrder direction: asc or desc

Output

ParameterTypeDescription
tagsarrayList of tags
↳ idnumberTag ID
↳ countnumberNumber of posts with this tag
↳ descriptionstringTag description
↳ linkstringTag archive URL
↳ namestringTag name
↳ slugstringTag slug
↳ taxonomystringTaxonomy name
totalnumberTotal number of tags
totalPagesnumberTotal number of result pages

WordPress Get Tag

Get a single tag from WordPress.com by ID

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
tagIdnumberYesThe ID of the tag to retrieve

Output

ParameterTypeDescription
tagobjectThe retrieved tag
↳ idnumberTag ID
↳ countnumberNumber of posts with this tag
↳ descriptionstringTag description
↳ linkstringTag archive URL
↳ namestringTag name
↳ slugstringTag slug
↳ taxonomystringTaxonomy name

WordPress Update Tag

Update an existing tag in WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
tagIdnumberYesThe ID of the tag to update
namestringNoTag name
descriptionstringNoTag description
slugstringNoURL slug for the tag

Output

ParameterTypeDescription
tagobjectThe updated tag
↳ idnumberTag ID
↳ countnumberNumber of posts with this tag
↳ descriptionstringTag description
↳ linkstringTag archive URL
↳ namestringTag name
↳ slugstringTag slug
↳ taxonomystringTaxonomy name

WordPress Delete Tag

Delete a tag from WordPress.com

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
tagIdnumberYesThe ID of the tag to delete

Output

ParameterTypeDescription
deletedbooleanWhether the tag was deleted
tagobjectThe deleted tag
↳ idnumberTag ID
↳ countnumberNumber of posts with this tag
↳ descriptionstringTag description
↳ linkstringTag archive URL
↳ namestringTag name
↳ slugstringTag slug
↳ taxonomystringTaxonomy name

WordPress Get Current User

Get information about the currently authenticated WordPress.com user

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)

Output

ParameterTypeDescription
userobjectThe current user
↳ idnumberUser ID
↳ usernamestringUsername
↳ namestringDisplay name
↳ first_namestringFirst name
↳ last_namestringLast name
↳ emailstringEmail address
↳ urlstringUser website URL
↳ descriptionstringUser bio
↳ linkstringAuthor archive URL
↳ slugstringUser slug
↳ rolesarrayUser roles
↳ avatar_urlsobjectAvatar URLs at different sizes

WordPress List Users

List users from WordPress.com (requires admin privileges)

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
perPagenumberNoNumber of users per request (e.g., 10, 25, 50). Default: 10, max: 100
pagenumberNoPage number for pagination (e.g., 1, 2, 3)
searchstringNoSearch term to filter users (e.g., "john", "admin")
rolesstringNoComma-separated role names to filter by (e.g., "administrator,editor")
orderstringNoOrder direction: asc or desc

Output

ParameterTypeDescription
usersarrayList of users
↳ idnumberUser ID
↳ usernamestringUsername
↳ namestringDisplay name
↳ first_namestringFirst name
↳ last_namestringLast name
↳ emailstringEmail address
↳ urlstringUser website URL
↳ descriptionstringUser bio
↳ linkstringAuthor archive URL
↳ slugstringUser slug
↳ rolesarrayUser roles
↳ avatar_urlsobjectAvatar URLs at different sizes
totalnumberTotal number of users
totalPagesnumberTotal number of result pages

WordPress Get User

Get a specific user from WordPress.com by ID

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
userIdnumberYesThe ID of the user to retrieve

Output

ParameterTypeDescription
userobjectThe retrieved user
↳ idnumberUser ID
↳ usernamestringUsername
↳ namestringDisplay name
↳ first_namestringFirst name
↳ last_namestringLast name
↳ emailstringEmail address
↳ urlstringUser website URL
↳ descriptionstringUser bio
↳ linkstringAuthor archive URL
↳ slugstringUser slug
↳ rolesarrayUser roles
↳ avatar_urlsobjectAvatar URLs at different sizes

WordPress Search Content

Search across all content types in WordPress.com (posts, pages, media)

Input

ParameterTypeRequiredDescription
siteIdstringYesWordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com)
querystringYesSearch query
perPagenumberNoNumber of results per request (default: 10, max: 100)
pagenumberNoPage number for pagination
typestringNoFilter by search index type: post, term, or post-format
subtypestringNoFilter by subtype within the selected type (e.g., post or page when type is post)

Output

ParameterTypeDescription
resultsarraySearch results
↳ idnumberContent ID
↳ titlestringContent title
↳ urlstringContent URL
↳ typestringContent type (post, term, or post-format)
↳ subtypestringSubtype within the content type (e.g., post, page)
totalnumberTotal number of results
totalPagesnumberTotal number of result pages