WordPress é o sistema de gerenciamento de conteúdo open-source líder mundial, alimentando websites, blogs e lojas online de todos os tamanhos. O WordPress oferece uma plataforma flexível para publicar e gerenciar conteúdo, com amplo suporte a plugins e temas.
Com a integração WordPress no Zoen, você pode:
- Gerenciar posts: Crie, atualize, exclua, obtenha e liste posts de blog com controle total sobre conteúdo, status, categorias e tags
- Gerenciar páginas: Crie, atualize, exclua, obtenha e liste páginas estáticas
- Lidar com mídia: Faça upload, obtenha, liste e exclua arquivos de mídia como imagens, vídeos e documentos
- Moderar comentários: Crie, liste, atualize e exclua comentários em posts e páginas
- Organizar conteúdo: Crie e liste categorias e tags para taxonomia de conteúdo
- Gerenciar usuários: Obtenha o usuário atual, liste usuários e recupere detalhes de usuários
- Pesquisar conteúdo: Pesquise em todos os tipos de conteúdo no site WordPress
No Zoen, a integração com o WordPress permite que seus agentes automatizem a publicação de conteúdo e o gerenciamento do site como parte de workflows automatizados. Os agentes podem criar e publicar posts, gerenciar ativos de mídia, moderar comentários e organizar conteúdo — mantendo seu website atualizado e organizado sem esforço manual.
Integrate with WordPress.com to create, update, and manage posts, pages, media, comments, categories, tags, and users. Connects to WordPress.com sites via OAuth.
Create a new blog post in WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
title | string | Yes | Post title |
content | string | No | Post content (HTML or plain text) |
status | string | No | Post status: publish, draft, pending, private, or future |
excerpt | string | No | Post excerpt |
categories | string | No | Comma-separated category IDs |
tags | string | No | Comma-separated tag IDs |
featuredMedia | number | No | Featured image media ID |
slug | string | No | URL slug for the post |
| Parameter | Type | Description |
|---|
post | object | The created post |
↳ id | number | Post ID |
↳ date | string | Post creation date |
↳ modified | string | Post modification date |
↳ slug | string | Post slug |
↳ status | string | Post status |
↳ type | string | Post type |
↳ link | string | Post URL |
↳ title | object | Post title object |
↳ content | object | Post content object |
↳ excerpt | object | Post excerpt object |
↳ author | number | Author ID |
↳ featured_media | number | Featured media ID |
↳ categories | array | Category IDs |
↳ tags | array | Tag IDs |
Update an existing blog post in WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
postId | number | Yes | The ID of the post to update |
title | string | No | Post title |
content | string | No | Post content (HTML or plain text) |
status | string | No | Post status: publish, draft, pending, private, or future |
excerpt | string | No | Post excerpt |
categories | string | No | Comma-separated category IDs |
tags | string | No | Comma-separated tag IDs |
featuredMedia | number | No | Featured image media ID |
slug | string | No | URL slug for the post |
| Parameter | Type | Description |
|---|
post | object | The updated post |
↳ id | number | Post ID |
↳ date | string | Post creation date |
↳ modified | string | Post modification date |
↳ slug | string | Post slug |
↳ status | string | Post status |
↳ type | string | Post type |
↳ link | string | Post URL |
↳ title | object | Post title object |
↳ content | object | Post content object |
↳ excerpt | object | Post excerpt object |
↳ author | number | Author ID |
↳ featured_media | number | Featured media ID |
↳ categories | array | Category IDs |
↳ tags | array | Tag IDs |
Delete a blog post from WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
postId | number | Yes | The ID of the post to delete |
force | boolean | No | Bypass trash and force delete permanently |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the post was deleted |
post | object | The deleted post |
↳ id | number | Post ID |
↳ date | string | Post creation date |
↳ modified | string | Post modification date |
↳ slug | string | Post slug |
↳ status | string | Post status |
↳ type | string | Post type |
↳ link | string | Post URL |
↳ title | object | Post title object |
↳ content | object | Post content object |
↳ excerpt | object | Post excerpt object |
↳ author | number | Author ID |
↳ featured_media | number | Featured media ID |
↳ categories | array | Category IDs |
↳ tags | array | Tag IDs |
Get a single blog post from WordPress.com by ID
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
postId | number | Yes | The ID of the post to retrieve |
| Parameter | Type | Description |
|---|
post | object | The retrieved post |
↳ id | number | Post ID |
↳ date | string | Post creation date |
↳ modified | string | Post modification date |
↳ slug | string | Post slug |
↳ status | string | Post status |
↳ type | string | Post type |
↳ link | string | Post URL |
↳ title | object | Post title object |
↳ content | object | Post content object |
↳ excerpt | object | Post excerpt object |
↳ author | number | Author ID |
↳ featured_media | number | Featured media ID |
↳ categories | array | Category IDs |
↳ tags | array | Tag IDs |
List blog posts from WordPress.com with optional filters
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
perPage | number | No | Number of posts per page (e.g., 10, 25, 50). Default: 10, max: 100 |
page | number | No | Page number for pagination (e.g., 1, 2, 3) |
status | string | No | Post status filter: publish, draft, pending, private |
author | number | No | Filter by author ID (e.g., 1, 42) |
categories | string | No | Comma-separated category IDs to filter by (e.g., "1,2,3") |
tags | string | No | Comma-separated tag IDs to filter by (e.g., "5,10,15") |
search | string | No | Search term to filter posts (e.g., "tutorial", "announcement") |
orderBy | string | No | Order by field: date, id, title, slug, modified |
order | string | No | Order direction: asc or desc |
| Parameter | Type | Description |
|---|
posts | array | List of posts |
↳ id | number | Post ID |
↳ date | string | Post creation date |
↳ modified | string | Post modification date |
↳ slug | string | Post slug |
↳ status | string | Post status |
↳ type | string | Post type |
↳ link | string | Post URL |
↳ title | object | Post title object |
↳ content | object | Post content object |
↳ excerpt | object | Post excerpt object |
↳ author | number | Author ID |
↳ featured_media | number | Featured media ID |
↳ categories | array | Category IDs |
↳ tags | array | Tag IDs |
total | number | Total number of posts |
totalPages | number | Total number of pages |
Create a new page in WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
title | string | Yes | Page title |
content | string | No | Page content (HTML or plain text) |
status | string | No | Page status: publish, draft, pending, private |
excerpt | string | No | Page excerpt |
parent | number | No | Parent page ID for hierarchical pages |
menuOrder | number | No | Order in page menu |
featuredMedia | number | No | Featured image media ID |
slug | string | No | URL slug for the page |
| Parameter | Type | Description |
|---|
page | object | The created page |
↳ id | number | Page ID |
↳ date | string | Page creation date |
↳ modified | string | Page modification date |
↳ slug | string | Page slug |
↳ status | string | Page status |
↳ type | string | Content type |
↳ link | string | Page URL |
↳ title | object | Page title object |
↳ content | object | Page content object |
↳ excerpt | object | Page excerpt object |
↳ author | number | Author ID |
↳ featured_media | number | Featured media ID |
↳ parent | number | Parent page ID |
↳ menu_order | number | Menu order |
Update an existing page in WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
pageId | number | Yes | The ID of the page to update |
title | string | No | Page title |
content | string | No | Page content (HTML or plain text) |
status | string | No | Page status: publish, draft, pending, private |
excerpt | string | No | Page excerpt |
parent | number | No | Parent page ID for hierarchical pages |
menuOrder | number | No | Order in page menu |
featuredMedia | number | No | Featured image media ID |
slug | string | No | URL slug for the page |
| Parameter | Type | Description |
|---|
page | object | The updated page |
↳ id | number | Page ID |
↳ date | string | Page creation date |
↳ modified | string | Page modification date |
↳ slug | string | Page slug |
↳ status | string | Page status |
↳ type | string | Content type |
↳ link | string | Page URL |
↳ title | object | Page title object |
↳ content | object | Page content object |
↳ excerpt | object | Page excerpt object |
↳ author | number | Author ID |
↳ featured_media | number | Featured media ID |
↳ parent | number | Parent page ID |
↳ menu_order | number | Menu order |
Delete a page from WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
pageId | number | Yes | The ID of the page to delete |
force | boolean | No | Bypass trash and force delete permanently |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the page was deleted |
page | object | The deleted page |
↳ id | number | Page ID |
↳ date | string | Page creation date |
↳ modified | string | Page modification date |
↳ slug | string | Page slug |
↳ status | string | Page status |
↳ type | string | Content type |
↳ link | string | Page URL |
↳ title | object | Page title object |
↳ content | object | Page content object |
↳ excerpt | object | Page excerpt object |
↳ author | number | Author ID |
↳ featured_media | number | Featured media ID |
↳ parent | number | Parent page ID |
↳ menu_order | number | Menu order |
Get a single page from WordPress.com by ID
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
pageId | number | Yes | The ID of the page to retrieve |
| Parameter | Type | Description |
|---|
page | object | The retrieved page |
↳ id | number | Page ID |
↳ date | string | Page creation date |
↳ modified | string | Page modification date |
↳ slug | string | Page slug |
↳ status | string | Page status |
↳ type | string | Content type |
↳ link | string | Page URL |
↳ title | object | Page title object |
↳ content | object | Page content object |
↳ excerpt | object | Page excerpt object |
↳ author | number | Author ID |
↳ featured_media | number | Featured media ID |
↳ parent | number | Parent page ID |
↳ menu_order | number | Menu order |
List pages from WordPress.com with optional filters
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
perPage | number | No | Number of pages per request (e.g., 10, 25, 50). Default: 10, max: 100 |
page | number | No | Page number for pagination (e.g., 1, 2, 3) |
status | string | No | Page status filter: publish, draft, pending, private |
parent | number | No | Filter by parent page ID (e.g., 123) |
search | string | No | Search term to filter pages (e.g., "about", "contact") |
orderBy | string | No | Order by field: date, id, title, slug, modified, menu_order |
order | string | No | Order direction: asc or desc |
| Parameter | Type | Description |
|---|
pages | array | List of pages |
↳ id | number | Page ID |
↳ date | string | Page creation date |
↳ modified | string | Page modification date |
↳ slug | string | Page slug |
↳ status | string | Page status |
↳ type | string | Content type |
↳ link | string | Page URL |
↳ title | object | Page title object |
↳ content | object | Page content object |
↳ excerpt | object | Page excerpt object |
↳ author | number | Author ID |
↳ featured_media | number | Featured media ID |
↳ parent | number | Parent page ID |
↳ menu_order | number | Menu order |
total | number | Total number of pages |
totalPages | number | Total number of result pages |
Upload a media file (image, video, document) to WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
file | file | No | File to upload (UserFile object) |
filename | string | No | Optional filename override (e.g., image.jpg) |
title | string | No | Media title |
caption | string | No | Media caption |
altText | string | No | Alternative text for accessibility |
description | string | No | Media description |
| Parameter | Type | Description |
|---|
media | object | The uploaded media item |
↳ id | number | Media ID |
↳ date | string | Upload date |
↳ slug | string | Media slug |
↳ type | string | Content type |
↳ link | string | Media page URL |
↳ title | object | Media title object |
↳ caption | object | Media caption object |
↳ alt_text | string | Alt text |
↳ media_type | string | Media type (image, video, etc.) |
↳ mime_type | string | MIME type |
↳ source_url | string | Direct URL to the media file |
↳ media_details | object | Media details (dimensions, etc.) |
Get a single media item from WordPress.com by ID
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
mediaId | number | Yes | The ID of the media item to retrieve |
| Parameter | Type | Description |
|---|
media | object | The retrieved media item |
↳ id | number | Media ID |
↳ date | string | Upload date |
↳ slug | string | Media slug |
↳ type | string | Content type |
↳ link | string | Media page URL |
↳ title | object | Media title object |
↳ caption | object | Media caption object |
↳ alt_text | string | Alt text |
↳ media_type | string | Media type (image, video, etc.) |
↳ mime_type | string | MIME type |
↳ source_url | string | Direct URL to the media file |
↳ media_details | object | Media details (dimensions, etc.) |
List media items from the WordPress.com media library
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
perPage | number | No | Number of media items per request (e.g., 10, 25, 50). Default: 10, max: 100 |
page | number | No | Page number for pagination (e.g., 1, 2, 3) |
search | string | No | Search term to filter media (e.g., "logo", "banner") |
mediaType | string | No | Filter by media type: image, video, audio, application |
mimeType | string | No | Filter by specific MIME type (e.g., image/jpeg, image/png) |
orderBy | string | No | Order by field: date, id, title, slug |
order | string | No | Order direction: asc or desc |
| Parameter | Type | Description |
|---|
media | array | List of media items |
↳ id | number | Media ID |
↳ date | string | Upload date |
↳ slug | string | Media slug |
↳ type | string | Content type |
↳ link | string | Media page URL |
↳ title | object | Media title object |
↳ caption | object | Media caption object |
↳ alt_text | string | Alt text |
↳ media_type | string | Media type (image, video, etc.) |
↳ mime_type | string | MIME type |
↳ source_url | string | Direct URL to the media file |
↳ media_details | object | Media details (dimensions, etc.) |
total | number | Total number of media items |
totalPages | number | Total number of result pages |
Delete a media item from WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
mediaId | number | Yes | The ID of the media item to delete |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the media was deleted |
media | object | The deleted media item |
↳ id | number | Media ID |
↳ date | string | Upload date |
↳ slug | string | Media slug |
↳ type | string | Content type |
↳ link | string | Media page URL |
↳ title | object | Media title object |
↳ caption | object | Media caption object |
↳ alt_text | string | Alt text |
↳ media_type | string | Media type (image, video, etc.) |
↳ mime_type | string | MIME type |
↳ source_url | string | Direct URL to the media file |
↳ media_details | object | Media details (dimensions, etc.) |
Create a new comment on a WordPress.com post
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
postId | number | Yes | The ID of the post to comment on |
content | string | Yes | Comment content |
parent | number | No | Parent comment ID for replies |
authorName | string | No | Comment author display name |
authorEmail | string | No | Comment author email |
authorUrl | string | No | Comment author URL |
| Parameter | Type | Description |
|---|
comment | object | The created comment |
↳ id | number | Comment ID |
↳ post | number | Post ID |
↳ parent | number | Parent comment ID |
↳ author | number | Author user ID |
↳ author_name | string | Author display name |
↳ author_email | string | Author email |
↳ author_url | string | Author URL |
↳ date | string | Comment date |
↳ content | object | Comment content object |
↳ link | string | Comment permalink |
↳ status | string | Comment status |
List comments from WordPress.com with optional filters
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
perPage | number | No | Number of comments per request (e.g., 10, 25, 50). Default: 10, max: 100 |
page | number | No | Page number for pagination (e.g., 1, 2, 3) |
postId | number | No | Filter by post ID (e.g., 123, 456) |
status | string | No | Filter by comment status: approved, hold, spam, trash |
search | string | No | Search term to filter comments (e.g., "question", "feedback") |
orderBy | string | No | Order by field: date, id, parent |
order | string | No | Order direction: asc or desc |
| Parameter | Type | Description |
|---|
comments | array | List of comments |
↳ id | number | Comment ID |
↳ post | number | Post ID |
↳ parent | number | Parent comment ID |
↳ author | number | Author user ID |
↳ author_name | string | Author display name |
↳ author_email | string | Author email |
↳ author_url | string | Author URL |
↳ date | string | Comment date |
↳ content | object | Comment content object |
↳ link | string | Comment permalink |
↳ status | string | Comment status |
total | number | Total number of comments |
totalPages | number | Total number of result pages |
Update a comment in WordPress.com (content or status)
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
commentId | number | Yes | The ID of the comment to update |
content | string | No | Updated comment content |
status | string | No | Comment status: approved, hold, spam, trash |
| Parameter | Type | Description |
|---|
comment | object | The updated comment |
↳ id | number | Comment ID |
↳ post | number | Post ID |
↳ parent | number | Parent comment ID |
↳ author | number | Author user ID |
↳ author_name | string | Author display name |
↳ author_email | string | Author email |
↳ author_url | string | Author URL |
↳ date | string | Comment date |
↳ content | object | Comment content object |
↳ link | string | Comment permalink |
↳ status | string | Comment status |
Delete a comment from WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
commentId | number | Yes | The ID of the comment to delete |
force | boolean | No | Bypass trash and force delete permanently |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the comment was deleted |
comment | object | The deleted comment |
↳ id | number | Comment ID |
↳ post | number | Post ID |
↳ parent | number | Parent comment ID |
↳ author | number | Author user ID |
↳ author_name | string | Author display name |
↳ author_email | string | Author email |
↳ author_url | string | Author URL |
↳ date | string | Comment date |
↳ content | object | Comment content object |
↳ link | string | Comment permalink |
↳ status | string | Comment status |
Create a new category in WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
name | string | Yes | Category name |
description | string | No | Category description |
parent | number | No | Parent category ID for hierarchical categories |
slug | string | No | URL slug for the category |
| Parameter | Type | Description |
|---|
category | object | The created category |
↳ id | number | Category ID |
↳ count | number | Number of posts in this category |
↳ description | string | Category description |
↳ link | string | Category archive URL |
↳ name | string | Category name |
↳ slug | string | Category slug |
↳ taxonomy | string | Taxonomy name |
↳ parent | number | Parent category ID |
List categories from WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
perPage | number | No | Number of categories per request (e.g., 10, 25, 50). Default: 10, max: 100 |
page | number | No | Page number for pagination (e.g., 1, 2, 3) |
search | string | No | Search term to filter categories (e.g., "news", "technology") |
order | string | No | Order direction: asc or desc |
| Parameter | Type | Description |
|---|
categories | array | List of categories |
↳ id | number | Category ID |
↳ count | number | Number of posts in this category |
↳ description | string | Category description |
↳ link | string | Category archive URL |
↳ name | string | Category name |
↳ slug | string | Category slug |
↳ taxonomy | string | Taxonomy name |
↳ parent | number | Parent category ID |
total | number | Total number of categories |
totalPages | number | Total number of result pages |
Get a single category from WordPress.com by ID
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
categoryId | number | Yes | The ID of the category to retrieve |
| Parameter | Type | Description |
|---|
category | object | The retrieved category |
↳ id | number | Category ID |
↳ count | number | Number of posts in this category |
↳ description | string | Category description |
↳ link | string | Category archive URL |
↳ name | string | Category name |
↳ slug | string | Category slug |
↳ taxonomy | string | Taxonomy name |
↳ parent | number | Parent category ID |
Update an existing category in WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
categoryId | number | Yes | The ID of the category to update |
name | string | No | Category name |
description | string | No | Category description |
parent | number | No | Parent category ID for hierarchical categories |
slug | string | No | URL slug for the category |
| Parameter | Type | Description |
|---|
category | object | The updated category |
↳ id | number | Category ID |
↳ count | number | Number of posts in this category |
↳ description | string | Category description |
↳ link | string | Category archive URL |
↳ name | string | Category name |
↳ slug | string | Category slug |
↳ taxonomy | string | Taxonomy name |
↳ parent | number | Parent category ID |
Delete a category from WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
categoryId | number | Yes | The ID of the category to delete |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the category was deleted |
category | object | The deleted category |
↳ id | number | Category ID |
↳ count | number | Number of posts in this category |
↳ description | string | Category description |
↳ link | string | Category archive URL |
↳ name | string | Category name |
↳ slug | string | Category slug |
↳ taxonomy | string | Taxonomy name |
↳ parent | number | Parent category ID |
Create a new tag in WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
name | string | Yes | Tag name |
description | string | No | Tag description |
slug | string | No | URL slug for the tag |
| Parameter | Type | Description |
|---|
tag | object | The created tag |
↳ id | number | Tag ID |
↳ count | number | Number of posts with this tag |
↳ description | string | Tag description |
↳ link | string | Tag archive URL |
↳ name | string | Tag name |
↳ slug | string | Tag slug |
↳ taxonomy | string | Taxonomy name |
List tags from WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
perPage | number | No | Number of tags per request (e.g., 10, 25, 50). Default: 10, max: 100 |
page | number | No | Page number for pagination (e.g., 1, 2, 3) |
search | string | No | Search term to filter tags (e.g., "javascript", "tutorial") |
order | string | No | Order direction: asc or desc |
| Parameter | Type | Description |
|---|
tags | array | List of tags |
↳ id | number | Tag ID |
↳ count | number | Number of posts with this tag |
↳ description | string | Tag description |
↳ link | string | Tag archive URL |
↳ name | string | Tag name |
↳ slug | string | Tag slug |
↳ taxonomy | string | Taxonomy name |
total | number | Total number of tags |
totalPages | number | Total number of result pages |
Get a single tag from WordPress.com by ID
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
tagId | number | Yes | The ID of the tag to retrieve |
| Parameter | Type | Description |
|---|
tag | object | The retrieved tag |
↳ id | number | Tag ID |
↳ count | number | Number of posts with this tag |
↳ description | string | Tag description |
↳ link | string | Tag archive URL |
↳ name | string | Tag name |
↳ slug | string | Tag slug |
↳ taxonomy | string | Taxonomy name |
Update an existing tag in WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
tagId | number | Yes | The ID of the tag to update |
name | string | No | Tag name |
description | string | No | Tag description |
slug | string | No | URL slug for the tag |
| Parameter | Type | Description |
|---|
tag | object | The updated tag |
↳ id | number | Tag ID |
↳ count | number | Number of posts with this tag |
↳ description | string | Tag description |
↳ link | string | Tag archive URL |
↳ name | string | Tag name |
↳ slug | string | Tag slug |
↳ taxonomy | string | Taxonomy name |
Delete a tag from WordPress.com
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
tagId | number | Yes | The ID of the tag to delete |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the tag was deleted |
tag | object | The deleted tag |
↳ id | number | Tag ID |
↳ count | number | Number of posts with this tag |
↳ description | string | Tag description |
↳ link | string | Tag archive URL |
↳ name | string | Tag name |
↳ slug | string | Tag slug |
↳ taxonomy | string | Taxonomy name |
Get information about the currently authenticated WordPress.com user
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
| Parameter | Type | Description |
|---|
user | object | The current user |
↳ id | number | User ID |
↳ username | string | Username |
↳ name | string | Display name |
↳ first_name | string | First name |
↳ last_name | string | Last name |
↳ email | string | Email address |
↳ url | string | User website URL |
↳ description | string | User bio |
↳ link | string | Author archive URL |
↳ slug | string | User slug |
↳ roles | array | User roles |
↳ avatar_urls | object | Avatar URLs at different sizes |
List users from WordPress.com (requires admin privileges)
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
perPage | number | No | Number of users per request (e.g., 10, 25, 50). Default: 10, max: 100 |
page | number | No | Page number for pagination (e.g., 1, 2, 3) |
search | string | No | Search term to filter users (e.g., "john", "admin") |
roles | string | No | Comma-separated role names to filter by (e.g., "administrator,editor") |
order | string | No | Order direction: asc or desc |
| Parameter | Type | Description |
|---|
users | array | List of users |
↳ id | number | User ID |
↳ username | string | Username |
↳ name | string | Display name |
↳ first_name | string | First name |
↳ last_name | string | Last name |
↳ email | string | Email address |
↳ url | string | User website URL |
↳ description | string | User bio |
↳ link | string | Author archive URL |
↳ slug | string | User slug |
↳ roles | array | User roles |
↳ avatar_urls | object | Avatar URLs at different sizes |
total | number | Total number of users |
totalPages | number | Total number of result pages |
Get a specific user from WordPress.com by ID
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
userId | number | Yes | The ID of the user to retrieve |
| Parameter | Type | Description |
|---|
user | object | The retrieved user |
↳ id | number | User ID |
↳ username | string | Username |
↳ name | string | Display name |
↳ first_name | string | First name |
↳ last_name | string | Last name |
↳ email | string | Email address |
↳ url | string | User website URL |
↳ description | string | User bio |
↳ link | string | Author archive URL |
↳ slug | string | User slug |
↳ roles | array | User roles |
↳ avatar_urls | object | Avatar URLs at different sizes |
Search across all content types in WordPress.com (posts, pages, media)
| Parameter | Type | Required | Description |
|---|
siteId | string | Yes | WordPress.com site ID or domain (e.g., 12345678 or mysite.wordpress.com) |
query | string | Yes | Search query |
perPage | number | No | Number of results per request (default: 10, max: 100) |
page | number | No | Page number for pagination |
type | string | No | Filter by search index type: post, term, or post-format |
subtype | string | No | Filter by subtype within the selected type (e.g., post or page when type is post) |
| Parameter | Type | Description |
|---|
results | array | Search results |
↳ id | number | Content ID |
↳ title | string | Content title |
↳ url | string | Content URL |
↳ type | string | Content type (post, term, or post-format) |
↳ subtype | string | Subtype within the content type (e.g., post, page) |
total | number | Total number of results |
totalPages | number | Total number of result pages |