Automattic Guidelines API
The guidelines API from Automattic — 6 operation(s) for guidelines.
The guidelines API from Automattic — 6 operation(s) for guidelines.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/automattic-guidelines-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: WordPress.com REST API — wp/v2 namespace Guidelines API
version: v2
description: Derived by API Evangelist from the WordPress.com REST API route index published at https://public-api.wordpress.com/wp/v2/. Paths, HTTP methods, and parameter names/types/descriptions/defaults are taken verbatim from that index. Response schemas are not published in the route index, so successful responses are described but not schematised; the error envelope was observed live on public-api.wordpress.com.
contact:
name: Automattic
url: https://developer.wordpress.com/docs/api/
x-derived-from: https://public-api.wordpress.com/wp/v2/
x-derived-by: API Evangelist enrichment pipeline
servers:
- url: https://public-api.wordpress.com
security:
- bearerAuth: []
tags:
- name: guidelines
paths:
/wp/v2/sites/{wpcom_site}/guidelines:
get:
operationId: getWpV2SitesbyWpcomSiteGuidelines
summary: GET /wp/v2/sites/{wpcom_site}/guidelines
tags:
- guidelines
responses:
'200':
description: OK
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
parameters:
- name: wpcom_site
in: path
required: true
schema:
type: string
- name: context
in: query
required: false
schema:
type: string
enum:
- view
- embed
- edit
default: view
description: Scope under which the request is made; determines fields present in response.
- name: page
in: query
required: false
schema:
type: integer
default: 1
description: Current page of the collection.
- name: per_page
in: query
required: false
schema:
type: integer
default: 10
description: Maximum number of items to be returned in result set.
- name: search
in: query
required: false
schema:
type: string
description: Limit results to those matching a string.
- name: after
in: query
required: false
schema:
type: string
format: date-time
description: Limit response to posts published after a given ISO8601 compliant date.
- name: modified_after
in: query
required: false
schema:
type: string
format: date-time
description: Limit response to posts modified after a given ISO8601 compliant date.
- name: author
in: query
required: false
schema:
type: array
default: []
items:
type: integer
description: Limit result set to posts assigned to specific authors.
- name: author_exclude
in: query
required: false
schema:
type: array
default: []
items:
type: integer
description: Ensure result set excludes posts assigned to specific authors.
- name: before
in: query
required: false
schema:
type: string
format: date-time
description: Limit response to posts published before a given ISO8601 compliant date.
- name: modified_before
in: query
required: false
schema:
type: string
format: date-time
description: Limit response to posts modified before a given ISO8601 compliant date.
- name: exclude
in: query
required: false
schema:
type: array
default: []
items:
type: integer
description: Ensure result set excludes specific IDs.
- name: include
in: query
required: false
schema:
type: array
default: []
items:
type: integer
description: Limit result set to specific IDs.
- name: search_semantics
in: query
required: false
schema:
type: string
enum:
- exact
description: How to interpret the search input.
- name: offset
in: query
required: false
schema:
type: integer
description: Offset the result set by a specific number of items.
- name: order
in: query
required: false
schema:
type: string
enum:
- asc
- desc
default: desc
description: Order sort attribute ascending or descending.
- name: orderby
in: query
required: false
schema:
type: string
enum:
- author
- date
- id
- include
- modified
- parent
- relevance
- slug
- include_slugs
- title
default: date
description: Sort collection by post attribute.
- name: search_columns
in: query
required: false
schema:
type: array
default: []
items:
type: string
description: Array of column names to be searched.
- name: slug
in: query
required: false
schema:
type: array
items:
type: string
description: Limit result set to posts with one or more specific slugs.
- name: status
in: query
required: false
schema:
type: array
default: publish
items:
type: string
description: Limit result set to posts assigned one or more statuses.
- name: tax_relation
in: query
required: false
schema:
type: string
enum:
- AND
- OR
description: Limit result set based on relationship between multiple taxonomies.
- name: wp_guideline_type
in: query
required: false
schema:
type: string
description: Limit result set to items with specific terms assigned in the wp_guideline_type taxonomy.
- name: wp_guideline_type_exclude
in: query
required: false
schema:
type: string
description: Limit result set to items except those with specific terms assigned in the wp_guideline_type taxonomy.
post:
operationId: postWpV2SitesbyWpcomSiteGuidelines
summary: POST /wp/v2/sites/{wpcom_site}/guidelines
tags:
- guidelines
responses:
'200':
description: OK
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
parameters:
- name: wpcom_site
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
date:
type: string
format: date-time
description: The date the post was published, in the site's timezone.
date_gmt:
type: string
format: date-time
description: The date the post was published, as GMT.
slug:
type: string
description: An alphanumeric identifier for the post unique to its type.
status:
type: string
enum:
- publish
- future
- draft
- pending
- private
- spam
description: A named status for the post.
password:
type: string
description: A password to protect access to the content and excerpt.
title:
type: object
description: The title for the post.
content:
type: object
description: The content for the post.
author:
type: integer
description: The ID for the author of the post.
excerpt:
type: object
description: The excerpt for the post.
template:
type: string
description: The theme file to use to display the post.
wp_guideline_type:
type: array
items:
type: integer
description: The terms assigned to the post in the wp_guideline_type taxonomy.
/wp/v2/sites/{wpcom_site}/guidelines/{id}:
get:
operationId: getWpV2SitesbyWpcomSiteGuidelinesbyId
summary: GET /wp/v2/sites/{wpcom_site}/guidelines/{id}
tags:
- guidelines
responses:
'200':
description: OK
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
parameters:
- name: wpcom_site
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
- name: context
in: query
required: false
schema:
type: string
enum:
- view
- embed
- edit
default: view
description: Scope under which the request is made; determines fields present in response.
- name: excerpt_length
in: query
required: false
schema:
type: integer
description: Override the default excerpt length.
- name: password
in: query
required: false
schema:
type: string
description: The password for the post if it is password protected.
post:
operationId: postWpV2SitesbyWpcomSiteGuidelinesbyId
summary: POST /wp/v2/sites/{wpcom_site}/guidelines/{id}
tags:
- guidelines
responses:
'200':
description: OK
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
parameters:
- name: wpcom_site
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
date:
type: string
format: date-time
description: The date the post was published, in the site's timezone.
date_gmt:
type: string
format: date-time
description: The date the post was published, as GMT.
slug:
type: string
description: An alphanumeric identifier for the post unique to its type.
status:
type: string
enum:
- publish
- future
- draft
- pending
- private
- spam
description: A named status for the post.
password:
type: string
description: A password to protect access to the content and excerpt.
title:
type: object
description: The title for the post.
content:
type: object
description: The content for the post.
author:
type: integer
description: The ID for the author of the post.
excerpt:
type: object
description: The excerpt for the post.
template:
type: string
description: The theme file to use to display the post.
wp_guideline_type:
type: array
items:
type: integer
description: The terms assigned to the post in the wp_guideline_type taxonomy.
put:
operationId: putWpV2SitesbyWpcomSiteGuidelinesbyId
summary: PUT /wp/v2/sites/{wpcom_site}/guidelines/{id}
tags:
- guidelines
responses:
'200':
description: OK
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
parameters:
- name: wpcom_site
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
date:
type: string
format: date-time
description: The date the post was published, in the site's timezone.
date_gmt:
type: string
format: date-time
description: The date the post was published, as GMT.
slug:
type: string
description: An alphanumeric identifier for the post unique to its type.
status:
type: string
enum:
- publish
- future
- draft
- pending
- private
- spam
description: A named status for the post.
password:
type: string
description: A password to protect access to the content and excerpt.
title:
type: object
description: The title for the post.
content:
type: object
description: The content for the post.
author:
type: integer
description: The ID for the author of the post.
excerpt:
type: object
description: The excerpt for the post.
template:
type: string
description: The theme file to use to display the post.
wp_guideline_type:
type: array
items:
type: integer
description: The terms assigned to the post in the wp_guideline_type taxonomy.
patch:
operationId: patchWpV2SitesbyWpcomSiteGuidelinesbyId
summary: PATCH /wp/v2/sites/{wpcom_site}/guidelines/{id}
tags:
- guidelines
responses:
'200':
description: OK
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
parameters:
- name: wpcom_site
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
date:
type: string
format: date-time
description: The date the post was published, in the site's timezone.
date_gmt:
type: string
format: date-time
description: The date the post was published, as GMT.
slug:
type: string
description: An alphanumeric identifier for the post unique to its type.
status:
type: string
enum:
- publish
- future
- draft
- pending
- private
- spam
description: A named status for the post.
password:
type: string
description: A password to protect access to the content and excerpt.
title:
type: object
description: The title for the post.
content:
type: object
description: The content for the post.
author:
type: integer
description: The ID for the author of the post.
excerpt:
type: object
description: The excerpt for the post.
template:
type: string
description: The theme file to use to display the post.
wp_guideline_type:
type: array
items:
type: integer
description: The terms assigned to the post in the wp_guideline_type taxonomy.
delete:
operationId: deleteWpV2SitesbyWpcomSiteGuidelinesbyId
summary: DELETE /wp/v2/sites/{wpcom_site}/guidelines/{id}
tags:
- guidelines
responses:
'200':
description: OK
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
parameters:
- name: wpcom_site
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
- name: force
in: query
required: false
schema:
type: boolean
default: false
description: Whether to bypass Trash and force deletion.
/wp/v2/sites/{wpcom_site}/guidelines/{id}/autosaves:
get:
operationId: getWpV2SitesbyWpcomSiteGuidelinesbyIdAutosaves
summary: GET /wp/v2/sites/{wpcom_site}/guidelines/{id}/autosaves
tags:
- guidelines
responses:
'200':
description: OK
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
parameters:
- name: wpcom_site
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
- name: parent
in: query
required: false
schema:
type: integer
description: The ID for the parent of the autosave.
- name: context
in: query
required: false
schema:
type: string
enum:
- view
- embed
- edit
default: view
description: Scope under which the request is made; determines fields present in response.
post:
operationId: postWpV2SitesbyWpcomSiteGuidelinesbyIdAutosaves
summary: POST /wp/v2/sites/{wpcom_site}/guidelines/{id}/autosaves
tags:
- guidelines
responses:
'200':
description: OK
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
parameters:
- name: wpcom_site
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
parent:
type: integer
description: The ID for the parent of the autosave.
date:
type: string
format: date-time
description: The date the post was published, in the site's timezone.
date_gmt:
type: string
format: date-time
description: The date the post was published, as GMT.
slug:
type: string
description: An alphanumeric identifier for the post unique to its type.
status:
type: string
enum:
- publish
- future
- draft
- pending
- private
- spam
description: A named status for the post.
password:
type: string
description: A password to protect access to the content and excerpt.
title:
type: object
description: The title for the post.
content:
type: object
description: The content for the post.
author:
type: integer
description: The ID for the author of the post.
excerpt:
type: object
description: The excerpt for the post.
template:
type: string
description: The theme file to use to display the post.
wp_guideline_type:
type: array
items:
type: integer
description: The terms assigned to the post in the wp_guideline_type taxonomy.
/wp/v2/sites/{wpcom_site}/guidelines/{parent}/autosaves/{id}:
get:
operationId: getWpV2SitesbyWpcomSiteGuidelinesbyParentAutosavesbyId
summary: GET /wp/v2/sites/{wpcom_site}/guidelines/{parent}/autosaves/{id}
tags:
- guidelines
responses:
'200':
description: OK
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
parameters:
- name: wpcom_site
in: path
required: true
schema:
type: string
- name: parent
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
- name: context
in: query
required: false
schema:
type: string
enum:
- view
- embed
- edit
default: view
description: Scope under which the request is made; determines fields present in response.
/wp/v2/sites/{wpcom_site}/guidelines/{parent}/revisions:
get:
operationId: getWpV2SitesbyWpcomSiteGuidelinesbyParentRevisions
summary: GET /wp/v2/sites/{wpcom_site}/guidelines/{parent}/revisions
tags:
- guidelines
responses:
'200':
description: OK
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
parameters:
- name: wpcom_site
in: path
required: true
schema:
type: string
- name: parent
in: path
required: true
schema:
type: string
- name: context
in: query
required: false
schema:
type: string
enum:
- view
- embed
- edit
default: view
description: Scope under which the request is made; determines fields present in response.
- name: page
in: query
required: false
schema:
type: integer
default: 1
description: Current page of the collection.
- name: per_page
in: query
required: false
schema:
type: integer
description: Maximum number of items to be returned in result set.
- name: search
in: query
required: false
schema:
type: string
description: Limit results to those matching a string.
- name: exclude
in: query
required: false
schema:
type: array
default: []
items:
type: integer
description: Ensure result set excludes specific IDs.
- name: include
in: query
required: false
schema:
type: array
default: []
items:
type: integer
description: Limit result set to specific IDs.
- name: offset
in: query
required: false
schema:
type: integer
description: Offset the result set by a specific number of items.
- name: order
in: query
required: false
schema:
type: string
enum:
- asc
- desc
default: desc
description: Order sort attribute ascending or descending.
- name: orderby
in: query
required: false
schema:
type: string
enum:
- date
- id
- include
- relevance
- slug
- include_slugs
- title
default: date
description: Sort collection by object attribute.
/wp/v2/sites/{wpcom_site}/guidelines/{parent}/revisions/{id}:
get:
operationId: getWpV2SitesbyWpcomSiteGuidelinesbyParentRevisionsbyId
summary: GET /wp/v2/sites/{wpcom_site}/guidelines/{parent}/revisions/{id}
tags:
- guidelines
responses:
'200':
description: OK
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
parameters:
- name: wpcom_site
in: path
required: true
schema:
type: string
- name: parent
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
- name: context
in: query
required: false
schema:
type: string
enum:
- view
- embed
- edit
default: view
description: Scope under which the request is made; determines fields present in response.
delete:
operationId: deleteWpV2SitesbyWpcomSiteGuidelinesbyParentRevisionsbyId
summary: DELETE /wp/v2/sites/{wpcom_site}/guidelines/{parent}/revisions/{id}
tags:
- guidelines
responses:
'200':
description: OK
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/WPRestError'
parameters:
- name: wpcom_site
in: path
required: true
schema:
type: string
- name: parent
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
- name: force
in: query
required: false
schema:
type: boolean
default: false
description: Required to be true, as revisions do not support trashing.
components:
schemas:
WPRestError:
type: object
description: WordPress REST API error envelope (observed on public-api.wordpress.com).
properties:
code:
type: string
example: rest_unauthorized
message:
type: string
example: Authentication required.
data:
type: object
properties:
status:
type: integer
example: 401
securitySchemes:
oauth2:
type: oauth2
description: WordPress.com OAuth 2.1, per https://public-api.wordpress.com/.well-known/openid-configuration
flows:
authorizationCode:
authorizationUrl: https://public-api.wordpress.com/oauth2-1/authorize
tokenUrl: https://public-api.wordpress.com/oauth2-1/token
refreshUrl: https://public-api.wordpress.com/oauth2-1/token
scopes:
global: ''
auth: ''
openid: ''
profile: ''
email: ''
users: ''
sites: ''
posts: ''
comments: ''
taxonomy: ''
follow: ''
sharing: ''
freshly-pressed: ''
notifications: ''
insights: ''
read: ''
stats: ''
media: ''
menus: ''
batch: ''
videos: ''
bearerAuth:
type: http
scheme: bearer