The schema defines all the fields that exist within a application password record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
uuid
|
The unique identifier for the application password. JSON data type: string, Format: uuid Read only Context: |
app_id
|
A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace. JSON data type: string, Format: uuid Context: |
name
|
The name of the application password. JSON data type: string Context: |
password
|
The generated password. Only available after adding an application. JSON data type: string Read only Context: |
created
|
The GMT date the application password was created. JSON data type: string, Format: datetime (details) Read only Context: |
last_used
|
The GMT date the application password was last used. JSON data type: string or null, Format: datetime (details) Read only Context: |
last_ip
|
The IP address the application password was last used by. JSON data type: string or null, Format: ip Read only Context: |
GET /wp/v2/users/<user_id>)/application-passwords
Query this endpoint to retrieve a specific application password record.
$ curl https://example.com/wp-json/wp/v2/users/<user_id>)/application-passwords
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
app_id |
A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace. |
name |
The name of the application password. Required: 1 |
POST /wp/v2/users/<user_id>)/application-passwords
There are no arguments for this endpoint.
DELETE /wp/v2/users/<user_id>)/application-passwords
$ curl -X DELETE https://example.com/wp-json/wp/v2/users/<user_id>)/application-passwords
GET /wp/v2/users/<user_id>)/application-passwords/introspect
Query this endpoint to retrieve a specific application password record.
$ curl https://example.com/wp-json/wp/v2/users/<user_id>)/application-passwords/introspect
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
GET /wp/v2/users/<user_id>)/application-passwords/<uuid>
Query this endpoint to retrieve a specific application password record.
$ curl https://example.com/wp-json/wp/v2/users/<user_id>)/application-passwords/<uuid>
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
app_id |
A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace. |
name |
The name of the application password. |
POST /wp/v2/users/<user_id>)/application-passwords/<uuid>
There are no arguments for this endpoint.
DELETE /wp/v2/users/<user_id>)/application-passwords/<uuid>
$ curl -X DELETE https://example.com/wp-json/wp/v2/users/<user_id>)/application-passwords/<uuid>
The schema defines all the fields that exist within a block directory item record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
name
|
The block name, in namespace/block-name format. JSON data type: string Context: |
title
|
The block title, in human readable format. JSON data type: string Context: |
description
|
A short description of the block, in human readable format. JSON data type: string Context: |
id
|
The block slug. JSON data type: string Context: |
rating
|
The star rating of the block. JSON data type: number Context: |
rating_count
|
The number of ratings. JSON data type: integer Context: |
active_installs
|
The number sites that have activated this block. JSON data type: integer Context: |
author_block_rating
|
The average rating of blocks published by the same author. JSON data type: number Context: |
author_block_count
|
The number of blocks published by the same author. JSON data type: integer Context: |
author
|
The WordPress.org username of the block author. JSON data type: string Context: |
icon
|
The block icon. JSON data type: string, Format: uri Context: |
last_updated
|
The date when the block was last updated. JSON data type: string, Format: datetime (details) Context: |
humanized_updated
|
The date when the block was last updated, in fuzzy human readable format. JSON data type: string Context: |
Query this endpoint to retrieve a collection of block directory items. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/block-directory/search
$ curl https://example.com/wp-json/wp/v2/block-directory/search
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
term |
Limit result set to blocks matching the search term. Required: 1 |
The schema defines all the fields that exist within a block pattern category record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
name
|
The category name. JSON data type: string Read only Context: |
label
|
The category label, in human readable format. JSON data type: string Read only Context: |
description
|
The category description, in human readable format. JSON data type: string Read only Context: |
GET /wp/v2/block-patterns/categories
Query this endpoint to retrieve a specific block pattern category record.
$ curl https://example.com/wp-json/wp/v2/block-patterns/categories
There are no arguments for this endpoint.
The schema defines all the fields that exist within a block pattern record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
name
|
The pattern name. JSON data type: string Read only Context: |
title
|
The pattern title, in human readable format. JSON data type: string Read only Context: |
content
|
The pattern content. JSON data type: string Read only Context: |
description
|
The pattern detailed description. JSON data type: string Read only Context: |
viewport_width
|
The pattern viewport width for inserter preview. JSON data type: number Read only Context: |
inserter
|
Determines whether the pattern is visible in inserter. JSON data type: boolean Read only Context: |
categories
|
The pattern category slugs. JSON data type: array Read only Context: |
keywords
|
The pattern keywords. JSON data type: array Read only Context: |
block_types
|
Block types that the pattern is intended to be used with. JSON data type: array Read only Context: |
post_types
|
An array of post types that the pattern is restricted to be used with. JSON data type: array Read only Context: |
template_types
|
An array of template types where the pattern fits. JSON data type: array Read only Context: |
source
|
Where the pattern comes from e.g. core JSON data type: string Read only Context: One of: |
GET /wp/v2/block-patterns/patterns
Query this endpoint to retrieve a specific block pattern record.
$ curl https://example.com/wp-json/wp/v2/block-patterns/patterns
There are no arguments for this endpoint.
The schema defines all the fields that exist within a Block Revision record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
author
|
The ID for the author of the revision. JSON data type: integer Context: |
date
|
The date the revision was published, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
date_gmt
|
The date the revision was published, as GMT. JSON data type: string, Format: datetime (details) Context: |
guid
|
The globally unique identifier for the post. JSON data type: object Read only Context: |
id
|
Unique identifier for the revision. JSON data type: integer Context: |
modified
|
The date the revision was last modified, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
modified_gmt
|
The date the revision was last modified, as GMT. JSON data type: string, Format: datetime (details) Context: |
parent
|
The ID for the parent of the revision. JSON data type: integer Context: |
slug
|
An alphanumeric identifier for the revision unique to its type. JSON data type: string Context: |
title
|
The title for the post. JSON data type: object Context: |
content
|
The content for the post. JSON data type: object Context: |
Query this endpoint to retrieve a collection of Block Revisions. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/blocks/<parent>/revisions
$ curl https://example.com/wp-json/wp/v2/blocks/<parent>/revisions
parent |
The ID for the parent of the revision. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
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: One of: |
orderby |
Sort collection by object attribute.
Default: One of: |
GET /wp/v2/blocks/<parent>/revisions/<id>
Query this endpoint to retrieve a specific Block Revision record.
$ curl https://example.com/wp-json/wp/v2/blocks/<parent>/revisions/<id>
parent |
The ID for the parent of the revision. |
id |
Unique identifier for the revision. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
parent |
The ID for the parent of the revision. |
id |
Unique identifier for the revision. |
force |
Required to be true, as revisions do not support trashing. |
DELETE /wp/v2/blocks/<parent>/revisions/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/blocks/<parent>/revisions/<id>
GET /wp/v2/blocks/<id>/autosaves
Query this endpoint to retrieve a specific Block Revision record.
$ curl https://example.com/wp-json/wp/v2/blocks/<id>/autosaves
parent |
The ID for the parent of the autosave. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
parent |
The ID for the parent of the autosave. |
date |
The date the post was published, in the site's timezone. |
date_gmt |
The date the post was published, as GMT. |
slug |
An alphanumeric identifier for the post unique to its type. |
status |
A named status for the post. One of: |
password |
A password to protect access to the content and excerpt. |
title |
The title for the post. |
content |
The content for the post. |
meta |
Meta fields. |
template |
The theme file to use to display the post. |
POST /wp/v2/blocks/<id>/autosaves
GET /wp/v2/blocks/<parent>/autosaves/<id>
Query this endpoint to retrieve a specific Block Revision record.
$ curl https://example.com/wp-json/wp/v2/blocks/<parent>/autosaves/<id>
parent |
The ID for the parent of the autosave. |
id |
The ID for the autosave. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
The schema defines all the fields that exist within a block type record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
api_version
|
Version of block API. JSON data type: integer Read only Context: |
title
|
Title of block type. JSON data type: string Read only Context: |
name
|
Unique name identifying the block type. JSON data type: string Read only Context: |
description
|
Description of block type. JSON data type: string Read only Context: |
icon
|
Icon of block type. JSON data type: string or null Read only Context: |
attributes
|
Block attributes. JSON data type: object or null Read only Context: |
provides_context
|
Context provided by blocks of this type. JSON data type: object Read only Context: |
uses_context
|
Context values inherited by blocks of this type. JSON data type: array Read only Context: |
selectors
|
Custom CSS selectors. JSON data type: object Read only Context: |
supports
|
Block supports. JSON data type: object Read only Context: |
category
|
Block category. JSON data type: string or null Read only Context: |
is_dynamic
|
Is the block dynamically rendered. JSON data type: boolean Read only Context: |
editor_script_handles
|
Editor script handles. JSON data type: array Read only Context: |
script_handles
|
Public facing and editor script handles. JSON data type: array Read only Context: |
view_script_handles
|
Public facing script handles. JSON data type: array Read only Context: |
editor_style_handles
|
Editor style handles. JSON data type: array Read only Context: |
style_handles
|
Public facing and editor style handles. JSON data type: array Read only Context: |
styles
|
Block style variations. JSON data type: array Read only Context: |
variations
|
Block variations. JSON data type: array Read only Context: |
textdomain
|
Public text domain. JSON data type: string or null Read only Context: |
parent
|
Parent blocks. JSON data type: array or null Read only Context: |
ancestor
|
Ancestor blocks. JSON data type: array or null Read only Context: |
keywords
|
Block keywords. JSON data type: array Read only Context: |
example
|
Block example. JSON data type: object or null Read only Context: |
editor_script
|
Editor script handle. DEPRECATED: Use `editor_script_handles` instead. JSON data type: string or null Read only Context: |
script
|
Public facing and editor script handle. DEPRECATED: Use `script_handles` instead. JSON data type: string or null Read only Context: |
view_script
|
Public facing script handle. DEPRECATED: Use `view_script_handles` instead. JSON data type: string or null Read only Context: |
editor_style
|
Editor style handle. DEPRECATED: Use `editor_style_handles` instead. JSON data type: string or null Read only Context: |
style
|
Public facing and editor style handle. DEPRECATED: Use `style_handles` instead. JSON data type: string or null Read only Context: |
GET /wp/v2/block-types
Query this endpoint to retrieve a specific block type record.
$ curl https://example.com/wp-json/wp/v2/block-types
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
namespace |
Block namespace. |
GET /wp/v2/block-types/<namespace>
Query this endpoint to retrieve a specific block type record.
$ curl https://example.com/wp-json/wp/v2/block-types/<namespace>
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
namespace |
Block namespace. |
GET /wp/v2/block-types/<namespace>/<name>
Query this endpoint to retrieve a specific block type record.
$ curl https://example.com/wp-json/wp/v2/block-types/<namespace>/<name>
name |
Block name. |
namespace |
Block namespace. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
The schema defines all the fields that exist within a Editor Block record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
date
|
The date the post was published, in the site's timezone. JSON data type: string or null, Format: datetime (details) Context: |
date_gmt
|
The date the post was published, as GMT. JSON data type: string or null, Format: datetime (details) Context: |
guid
|
The globally unique identifier for the post. JSON data type: object Read only Context: |
id
|
Unique identifier for the post. JSON data type: integer Read only Context: |
link
|
URL to the post. JSON data type: string, Format: uri Read only Context: |
modified
|
The date the post was last modified, in the site's timezone. JSON data type: string, Format: datetime (details) Read only Context: |
modified_gmt
|
The date the post was last modified, as GMT. JSON data type: string, Format: datetime (details) Read only Context: |
slug
|
An alphanumeric identifier for the post unique to its type. JSON data type: string Context: |
status
|
A named status for the post. JSON data type: string Context: One of: |
type
|
Type of post. JSON data type: string Read only Context: |
password
|
A password to protect access to the content and excerpt. JSON data type: string Context: |
title
|
The title for the post. JSON data type: object Context: |
content
|
The content for the post. JSON data type: object Context: |
meta
|
Meta fields. JSON data type: object Context: |
template
|
The theme file to use to display the post. JSON data type: string Context: |
Query this endpoint to retrieve a collection of Editor Blocks. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/blocks
$ curl https://example.com/wp-json/wp/v2/blocks
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
search |
Limit results to those matching a string. |
after |
Limit response to posts published after a given ISO8601 compliant date. |
modified_after |
Limit response to posts modified after a given ISO8601 compliant date. |
before |
Limit response to posts published before a given ISO8601 compliant date. |
modified_before |
Limit response to posts modified 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: One of: |
orderby |
Sort collection by post attribute.
Default: One of: |
search_columns |
Array of column names to be searched. |
slug |
Limit result set to posts with one or more specific slugs. |
status |
Limit result set to posts assigned one or more statuses.
Default: |
date |
The date the post was published, in the site's timezone. |
date_gmt |
The date the post was published, as GMT. |
slug |
An alphanumeric identifier for the post unique to its type. |
status |
A named status for the post. One of: |
password |
A password to protect access to the content and excerpt. |
title |
The title for the post. |
content |
The content for the post. |
meta |
Meta fields. |
template |
The theme file to use to display the post. |
POST /wp/v2/blocks
GET /wp/v2/blocks/<id>
Query this endpoint to retrieve a specific Editor Block record.
$ curl https://example.com/wp-json/wp/v2/blocks/<id>
id |
Unique identifier for the post. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
password |
The password for the post if it is password protected. |
id |
Unique identifier for the post. |
date |
The date the post was published, in the site's timezone. |
date_gmt |
The date the post was published, as GMT. |
slug |
An alphanumeric identifier for the post unique to its type. |
status |
A named status for the post. One of: |
password |
A password to protect access to the content and excerpt. |
title |
The title for the post. |
content |
The content for the post. |
meta |
Meta fields. |
template |
The theme file to use to display the post. |
POST /wp/v2/blocks/<id>
id |
Unique identifier for the post. |
force |
Whether to bypass Trash and force deletion. |
DELETE /wp/v2/blocks/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/blocks/<id>
The schema defines all the fields that exist within a category record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
id
|
Unique identifier for the term. JSON data type: integer Read only Context: |
count
|
Number of published posts for the term. JSON data type: integer Read only Context: |
description
|
HTML description of the term. JSON data type: string Context: |
link
|
URL of the term. JSON data type: string, Format: uri Read only Context: |
name
|
HTML title for the term. JSON data type: string Context: |
slug
|
An alphanumeric identifier for the term unique to its type. JSON data type: string Context: |
taxonomy
|
Type attribution for the term. JSON data type: string Read only Context: One of: |
parent
|
The parent term ID. JSON data type: integer Context: |
meta
|
Meta fields. JSON data type: object Context: |
Query this endpoint to retrieve a collection of categories. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/categories
$ curl https://example.com/wp-json/wp/v2/categories
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
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: One of: |
orderby |
Sort collection by term attribute.
Default: One of: |
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. |
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. |
POST /wp/v2/categories
GET /wp/v2/categories/<id>
Query this endpoint to retrieve a specific category record.
$ curl https://example.com/wp-json/wp/v2/categories/<id>
id |
Unique identifier for the term. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
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. |
POST /wp/v2/categories/<id>
id |
Unique identifier for the term. |
force |
Required to be true, as terms do not support trashing. |
DELETE /wp/v2/categories/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/categories/<id>
The schema defines all the fields that exist within a comment record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
id
|
Unique identifier for the comment. JSON data type: integer Read only Context: |
author
|
The ID of the user object, if author was a user. JSON data type: integer Context: |
author_email
|
Email address for the comment author. JSON data type: string, Format: email Context: |
author_ip
|
IP address for the comment author. JSON data type: string, Format: ip Context: |
author_name
|
Display name for the comment author. JSON data type: string Context: |
author_url
|
URL for the comment author. JSON data type: string, Format: uri Context: |
author_user_agent
|
User agent for the comment author. JSON data type: string Context: |
content
|
The content for the comment. JSON data type: object Context: |
date
|
The date the comment was published, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
date_gmt
|
The date the comment was published, as GMT. JSON data type: string, Format: datetime (details) Context: |
link
|
URL to the comment. JSON data type: string, Format: uri Read only Context: |
parent
|
The ID for the parent of the comment. JSON data type: integer Context: |
post
|
The ID of the associated post object. JSON data type: integer Context: |
status
|
State of the comment. JSON data type: string Context: |
type
|
Type of the comment. JSON data type: string Read only Context: |
author_avatar_urls
|
Avatar URLs for the comment author. JSON data type: object Read only Context: |
meta
|
Meta fields. JSON data type: object Context: |
Query this endpoint to retrieve a collection of comments. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/comments
$ curl https://example.com/wp-json/wp/v2/comments
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
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 a 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: One of: |
orderby |
Sort collection by comment attribute.
Default: One of: |
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: |
type |
Limit result set to comments assigned a specific type. Requires authorization.
Default: |
password |
The password for the post if it is password protected. |
author |
The ID of the user object, if author was a user. |
author_email |
Email address for the comment author. |
author_ip |
IP address for the comment author. |
author_name |
Display name for the comment author. |
author_url |
URL for the comment author. |
author_user_agent |
User agent for the comment author. |
content |
The content for the comment. |
date |
The date the comment was published, in the site's timezone. |
date_gmt |
The date the comment was published, as GMT. |
parent |
The ID for the parent of the comment. |
post |
The ID of the associated post object. |
status |
State of the comment. |
meta |
Meta fields. |
POST /wp/v2/comments
GET /wp/v2/comments/<id>
Query this endpoint to retrieve a specific comment record.
$ curl https://example.com/wp-json/wp/v2/comments/<id>
id |
Unique identifier for the comment. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
password |
The password for the parent post of the comment (if the post is password protected). |
id |
Unique identifier for the comment. |
author |
The ID of the user object, if author was a user. |
author_email |
Email address for the comment author. |
author_ip |
IP address for the comment author. |
author_name |
Display name for the comment author. |
author_url |
URL for the comment author. |
author_user_agent |
User agent for the comment author. |
content |
The content for the comment. |
date |
The date the comment was published, in the site's timezone. |
date_gmt |
The date the comment was published, as GMT. |
parent |
The ID for the parent of the comment. |
post |
The ID of the associated post object. |
status |
State of the comment. |
meta |
Meta fields. |
POST /wp/v2/comments/<id>
id |
Unique identifier for the comment. |
force |
Whether to bypass Trash and force deletion. |
password |
The password for the parent post of the comment (if the post is password protected). |
DELETE /wp/v2/comments/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/comments/<id>
The schema defines all the fields that exist within a Media Item record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
date
|
The date the post was published, in the site's timezone. JSON data type: string or null, Format: datetime (details) Context: |
date_gmt
|
The date the post was published, as GMT. JSON data type: string or null, Format: datetime (details) Context: |
guid
|
The globally unique identifier for the post. JSON data type: object Read only Context: |
id
|
Unique identifier for the post. JSON data type: integer Read only Context: |
link
|
URL to the post. JSON data type: string, Format: uri Read only Context: |
modified
|
The date the post was last modified, in the site's timezone. JSON data type: string, Format: datetime (details) Read only Context: |
modified_gmt
|
The date the post was last modified, as GMT. JSON data type: string, Format: datetime (details) Read only Context: |
slug
|
An alphanumeric identifier for the post unique to its type. JSON data type: string Context: |
status
|
A named status for the post. JSON data type: string Context: One of: |
type
|
Type of post. JSON data type: string Read only Context: |
permalink_template
|
Permalink template for the post. JSON data type: string Read only Context: |
generated_slug
|
Slug automatically generated from the post title. JSON data type: string Read only Context: |
title
|
The title for the post. JSON data type: object Context: |
author
|
The ID for the author of the post. JSON data type: integer Context: |
comment_status
|
Whether or not comments are open on the post. JSON data type: string Context: One of: |
ping_status
|
Whether or not the post can be pinged. JSON data type: string Context: One of: |
meta
|
Meta fields. JSON data type: object Context: |
template
|
The theme file to use to display the post. JSON data type: string Context: |
alt_text
|
Alternative text to display when attachment is not displayed. JSON data type: string Context: |
caption
|
The attachment caption. JSON data type: object Context: |
description
|
The attachment description. JSON data type: object Context: |
media_type
|
Attachment type. JSON data type: string Read only Context: One of: |
mime_type
|
The attachment MIME type. JSON data type: string Read only Context: |
media_details
|
Details about the media file, specific to its type. JSON data type: object Read only Context: |
post
|
The ID for the associated post of the attachment. JSON data type: integer Context: |
source_url
|
URL to the original attachment file. JSON data type: string, Format: uri Read only Context: |
missing_image_sizes
|
List of the missing image sizes of the attachment. JSON data type: array Read only Context: |
Query this endpoint to retrieve a collection of media. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/media
$ curl https://example.com/wp-json/wp/v2/media
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
search |
Limit results to those matching a string. |
after |
Limit response to posts published after a given ISO8601 compliant date. |
modified_after |
Limit response to posts modified 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. |
modified_before |
Limit response to posts modified 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: One of: |
orderby |
Sort collection by post attribute.
Default: One of: |
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. |
search_columns |
Array of column names to be searched. |
slug |
Limit result set to posts with one or more specific slugs. |
status |
Limit result set to posts assigned one or more statuses.
Default: |
media_type |
Limit result set to attachments of a particular media type. One of: |
mime_type |
Limit result set to attachments of a particular MIME type. |
date |
The date the post was published, in the site's timezone. |
date_gmt |
The date the post was published, as GMT. |
slug |
An alphanumeric identifier for the post unique to its type. |
status |
A named status for the post. One of: |
title |
The title for the post. |
author |
The ID for the author of the post. |
comment_status |
Whether or not comments are open on the post. One of: |
ping_status |
Whether or not the post can be pinged. One of: |
meta |
Meta fields. |
template |
The theme file to use to display the post. |
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. |
POST /wp/v2/media
GET /wp/v2/media/<id>
Query this endpoint to retrieve a specific Media Item record.
$ curl https://example.com/wp-json/wp/v2/media/<id>
id |
Unique identifier for the post. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
id |
Unique identifier for the post. |
date |
The date the post was published, in the site's timezone. |
date_gmt |
The date the post was published, as GMT. |
slug |
An alphanumeric identifier for the post unique to its type. |
status |
A named status for the post. One of: |
title |
The title for the post. |
author |
The ID for the author of the post. |
comment_status |
Whether or not comments are open on the post. One of: |
ping_status |
Whether or not the post can be pinged. One of: |
meta |
Meta fields. |
template |
The theme file to use to display the post. |
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. |
POST /wp/v2/media/<id>
id |
Unique identifier for the post. |
force |
Whether to bypass Trash and force deletion. |
DELETE /wp/v2/media/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/media/<id>
The schema defines all the fields that exist within a menu location record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
name
|
The name of the menu location. JSON data type: string Read only Context: |
description
|
The description of the menu location. JSON data type: string Read only Context: |
menu
|
The ID of the assigned menu. JSON data type: integer Read only Context: |
GET /wp/v2/menu-locations
Query this endpoint to retrieve a specific menu location record.
$ curl https://example.com/wp-json/wp/v2/menu-locations
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
GET /wp/v2/menu-locations/<location>
Query this endpoint to retrieve a specific menu location record.
$ curl https://example.com/wp-json/wp/v2/menu-locations/<location>
location |
An alphanumeric identifier for the menu location. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
The schema defines all the fields that exist within a nav_menu_item revision record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
author
|
The ID for the author of the revision. JSON data type: integer Context: |
date
|
The date the revision was published, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
date_gmt
|
The date the revision was published, as GMT. JSON data type: string, Format: datetime (details) Context: |
guid
|
GUID for the revision, as it exists in the database. JSON data type: string Context: |
id
|
Unique identifier for the revision. JSON data type: integer Context: |
modified
|
The date the revision was last modified, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
modified_gmt
|
The date the revision was last modified, as GMT. JSON data type: string, Format: datetime (details) Context: |
parent
|
The ID for the parent of the revision. JSON data type: integer Context: |
slug
|
An alphanumeric identifier for the revision unique to its type. JSON data type: string Context: |
title
|
The title for the object. JSON data type: string or object Context: |
preview_link
|
Preview link for the post. JSON data type: string, Format: uri Read only Context: |
GET /wp/v2/menu-items/<id>/autosaves
Query this endpoint to retrieve a specific nav_menu_item revision record.
$ curl https://example.com/wp-json/wp/v2/menu-items/<id>/autosaves
parent |
The ID for the parent of the autosave. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
parent |
The ID for the parent of the object. |
title |
The title for the object. |
type |
The family of objects originally represented, such as "post_type" or "taxonomy". One of: |
status |
A named status for the object. One of: |
attr_title |
Text for the title attribute of the link element for this menu item. |
classes |
Class names for the link element of this menu item. |
description |
The description of this menu item. |
menu_order |
The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0. |
object |
The type of object originally represented, such as "category", "post", or "attachment". |
object_id |
The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories. |
target |
The target attribute of the link element for this menu item. One of: |
url |
The URL to which this menu item points. |
xfn |
The XFN relationship expressed in the link of this menu item. |
menus |
The terms assigned to the object in the nav_menu taxonomy. |
meta |
Meta fields. |
POST /wp/v2/menu-items/<id>/autosaves
GET /wp/v2/menu-items/<parent>/autosaves/<id>
Query this endpoint to retrieve a specific nav_menu_item revision record.
$ curl https://example.com/wp-json/wp/v2/menu-items/<parent>/autosaves/<id>
parent |
The ID for the parent of the autosave. |
id |
The ID for the autosave. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
The schema defines all the fields that exist within a nav_menu_item record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
title
|
The title for the object. JSON data type: string or object Context: |
id
|
Unique identifier for the object. JSON data type: integer Read only Context: |
type_label
|
The singular label used to describe this type of menu item. JSON data type: string Read only Context: |
type
|
The family of objects originally represented, such as "post_type" or "taxonomy". JSON data type: string Context: One of: |
status
|
A named status for the object. JSON data type: string Context: One of: |
parent
|
The ID for the parent of the object. JSON data type: integer Context: |
attr_title
|
Text for the title attribute of the link element for this menu item. JSON data type: string Context: |
classes
|
Class names for the link element of this menu item. JSON data type: array Context: |
description
|
The description of this menu item. JSON data type: string Context: |
menu_order
|
The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0. JSON data type: integer Context: |
object
|
The type of object originally represented, such as "category", "post", or "attachment". JSON data type: string Context: |
object_id
|
The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories. JSON data type: integer Context: |
target
|
The target attribute of the link element for this menu item. JSON data type: string Context: One of: |
url
|
The URL to which this menu item points. JSON data type: string, Format: uri Context: |
xfn
|
The XFN relationship expressed in the link of this menu item. JSON data type: array Context: |
invalid
|
Whether the menu item represents an object that no longer exists. JSON data type: boolean Read only Context: |
menus
|
The terms assigned to the object in the nav_menu taxonomy. JSON data type: integer Context: |
meta
|
Meta fields. JSON data type: object Context: |
Query this endpoint to retrieve a collection of nav_menu_items. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/menu-items
$ curl https://example.com/wp-json/wp/v2/menu-items
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
search |
Limit results to those matching a string. |
after |
Limit response to posts published after a given ISO8601 compliant date. |
modified_after |
Limit response to posts modified after a given ISO8601 compliant date. |
before |
Limit response to posts published before a given ISO8601 compliant date. |
modified_before |
Limit response to posts modified 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: One of: |
orderby |
Sort collection by object attribute.
Default: One of: |
search_columns |
Array of column names to be searched. |
slug |
Limit result set to posts with one or more specific slugs. |
status |
Limit result set to posts assigned one or more statuses.
Default: |
tax_relation |
Limit result set based on relationship between multiple taxonomies. One of: |
menus |
Limit result set to items with specific terms assigned in the menus taxonomy. |
menus_exclude |
Limit result set to items except those with specific terms assigned in the menus taxonomy. |
menu_order |
Limit result set to posts with a specific menu_order value. |
title |
The title for the object. |
type |
The family of objects originally represented, such as "post_type" or "taxonomy".
Default: One of: |
status |
A named status for the object.
Default: One of: |
parent |
The ID for the parent of the object. |
attr_title |
Text for the title attribute of the link element for this menu item. |
classes |
Class names for the link element of this menu item. |
description |
The description of this menu item. |
menu_order |
The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.
Default: |
object |
The type of object originally represented, such as "category", "post", or "attachment". |
object_id |
The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories. |
target |
The target attribute of the link element for this menu item. One of: |
url |
The URL to which this menu item points. |
xfn |
The XFN relationship expressed in the link of this menu item. |
menus |
The terms assigned to the object in the nav_menu taxonomy. |
meta |
Meta fields. |
POST /wp/v2/menu-items
GET /wp/v2/menu-items/<id>
Query this endpoint to retrieve a specific nav_menu_item record.
$ curl https://example.com/wp-json/wp/v2/menu-items/<id>
id |
Unique identifier for the post. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
id |
Unique identifier for the post. |
title |
The title for the object. |
type |
The family of objects originally represented, such as "post_type" or "taxonomy". One of: |
status |
A named status for the object. One of: |
parent |
The ID for the parent of the object. |
attr_title |
Text for the title attribute of the link element for this menu item. |
classes |
Class names for the link element of this menu item. |
description |
The description of this menu item. |
menu_order |
The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0. |
object |
The type of object originally represented, such as "category", "post", or "attachment". |
object_id |
The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories. |
target |
The target attribute of the link element for this menu item. One of: |
url |
The URL to which this menu item points. |
xfn |
The XFN relationship expressed in the link of this menu item. |
menus |
The terms assigned to the object in the nav_menu taxonomy. |
meta |
Meta fields. |
POST /wp/v2/menu-items/<id>
id |
Unique identifier for the post. |
force |
Whether to bypass Trash and force deletion. |
DELETE /wp/v2/menu-items/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/menu-items/<id>
The schema defines all the fields that exist within a nav_menu record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
id
|
Unique identifier for the term. JSON data type: integer Read only Context: |
description
|
HTML description of the term. JSON data type: string Context: |
name
|
HTML title for the term. JSON data type: string Context: |
slug
|
An alphanumeric identifier for the term unique to its type. JSON data type: string Context: |
meta
|
Meta fields. JSON data type: object Context: |
locations
|
The locations assigned to the menu. JSON data type: array Context: |
auto_add
|
Whether to automatically add top level pages to this menu. JSON data type: boolean Context: |
Query this endpoint to retrieve a collection of nav_menus. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/menus
$ curl https://example.com/wp-json/wp/v2/menus
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
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: One of: |
orderby |
Sort collection by term attribute.
Default: One of: |
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. |
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. |
locations |
The locations assigned to the menu. |
auto_add |
Whether to automatically add top level pages to this menu. |
POST /wp/v2/menus
GET /wp/v2/menus/<id>
Query this endpoint to retrieve a specific nav_menu record.
$ curl https://example.com/wp-json/wp/v2/menus/<id>
id |
Unique identifier for the term. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
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. |
locations |
The locations assigned to the menu. |
auto_add |
Whether to automatically add top level pages to this menu. |
POST /wp/v2/menus/<id>
id |
Unique identifier for the term. |
force |
Required to be true, as terms do not support trashing. |
DELETE /wp/v2/menus/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/menus/<id>
The schema defines all the fields that exist within a navigation fallback record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
id
|
The unique identifier for the Navigation Menu. JSON data type: integer Read only Context: |
GET /wp-block-editor/v1/navigation-fallback
Query this endpoint to retrieve a specific navigation fallback record.
$ curl https://example.com/wp-json/wp-block-editor/v1/navigation-fallback
There are no arguments for this endpoint.
The schema defines all the fields that exist within a page revision record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
author
|
The ID for the author of the revision. JSON data type: integer Context: |
date
|
The date the revision was published, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
date_gmt
|
The date the revision was published, as GMT. JSON data type: string, Format: datetime (details) Context: |
guid
|
The globally unique identifier for the post. JSON data type: object Read only Context: |
id
|
Unique identifier for the revision. JSON data type: integer Context: |
modified
|
The date the revision was last modified, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
modified_gmt
|
The date the revision was last modified, as GMT. JSON data type: string, Format: datetime (details) Context: |
parent
|
The ID for the parent of the revision. JSON data type: integer Context: |
slug
|
An alphanumeric identifier for the revision unique to its type. JSON data type: string Context: |
title
|
The title for the post. JSON data type: object Context: |
content
|
The content for the post. JSON data type: object Context: |
excerpt
|
The excerpt for the post. JSON data type: object Context: |
Query this endpoint to retrieve a collection of page revisions. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/pages/<parent>/revisions
$ curl https://example.com/wp-json/wp/v2/pages/<parent>/revisions
parent |
The ID for the parent of the revision. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
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: One of: |
orderby |
Sort collection by object attribute.
Default: One of: |
GET /wp/v2/pages/<parent>/revisions/<id>
Query this endpoint to retrieve a specific page revision record.
$ curl https://example.com/wp-json/wp/v2/pages/<parent>/revisions/<id>
parent |
The ID for the parent of the revision. |
id |
Unique identifier for the revision. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
parent |
The ID for the parent of the revision. |
id |
Unique identifier for the revision. |
force |
Required to be true, as revisions do not support trashing. |
DELETE /wp/v2/pages/<parent>/revisions/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/pages/<parent>/revisions/<id>
GET /wp/v2/pages/<id>/autosaves
Query this endpoint to retrieve a specific page revision record.
$ curl https://example.com/wp-json/wp/v2/pages/<id>/autosaves
parent |
The ID for the parent of the autosave. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
parent |
The ID for the parent of the post. |
date |
The date the post was published, in the site's timezone. |
date_gmt |
The date the post was published, as GMT. |
slug |
An alphanumeric identifier for the post unique to its type. |
status |
A named status for the post. One of: |
password |
A password to protect access to the content and excerpt. |
title |
The title for the post. |
content |
The content for the post. |
author |
The ID for the author of the post. |
excerpt |
The excerpt for the post. |
featured_media |
The ID of the featured media for the post. |
comment_status |
Whether or not comments are open on the post. One of: |
ping_status |
Whether or not the post can be pinged. One of: |
menu_order |
The order of the post in relation to other posts. |
meta |
Meta fields. |
template |
The theme file to use to display the post. |
POST /wp/v2/pages/<id>/autosaves
GET /wp/v2/pages/<parent>/autosaves/<id>
Query this endpoint to retrieve a specific page revision record.
$ curl https://example.com/wp-json/wp/v2/pages/<parent>/autosaves/<id>
parent |
The ID for the parent of the autosave. |
id |
The ID for the autosave. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
The schema defines all the fields that exist within a page record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
date
|
The date the post was published, in the site's timezone. JSON data type: string or null, Format: datetime (details) Context: |
date_gmt
|
The date the post was published, as GMT. JSON data type: string or null, Format: datetime (details) Context: |
guid
|
The globally unique identifier for the post. JSON data type: object Read only Context: |
id
|
Unique identifier for the post. JSON data type: integer Read only Context: |
link
|
URL to the post. JSON data type: string, Format: uri Read only Context: |
modified
|
The date the post was last modified, in the site's timezone. JSON data type: string, Format: datetime (details) Read only Context: |
modified_gmt
|
The date the post was last modified, as GMT. JSON data type: string, Format: datetime (details) Read only Context: |
slug
|
An alphanumeric identifier for the post unique to its type. JSON data type: string Context: |
status
|
A named status for the post. JSON data type: string Context: One of: |
type
|
Type of post. JSON data type: string Read only Context: |
password
|
A password to protect access to the content and excerpt. JSON data type: string Context: |
permalink_template
|
Permalink template for the post. JSON data type: string Read only Context: |
generated_slug
|
Slug automatically generated from the post title. JSON data type: string Read only Context: |
parent
|
The ID for the parent of the post. JSON data type: integer Context: |
title
|
The title for the post. JSON data type: object Context: |
content
|
The content for the post. JSON data type: object Context: |
author
|
The ID for the author of the post. JSON data type: integer Context: |
excerpt
|
The excerpt for the post. JSON data type: object Context: |
featured_media
|
The ID of the featured media for the post. JSON data type: integer Context: |
comment_status
|
Whether or not comments are open on the post. JSON data type: string Context: One of: |
ping_status
|
Whether or not the post can be pinged. JSON data type: string Context: One of: |
menu_order
|
The order of the post in relation to other posts. JSON data type: integer Context: |
meta
|
Meta fields. JSON data type: object Context: |
template
|
The theme file to use to display the post. JSON data type: string Context: |
Query this endpoint to retrieve a collection of pages. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/pages
$ curl https://example.com/wp-json/wp/v2/pages
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
search |
Limit results to those matching a string. |
after |
Limit response to posts published after a given ISO8601 compliant date. |
modified_after |
Limit response to posts modified 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. |
modified_before |
Limit response to posts modified 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: One of: |
orderby |
Sort collection by post attribute.
Default: One of: |
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. |
search_columns |
Array of column names to be searched. |
slug |
Limit result set to posts with one or more specific slugs. |
status |
Limit result set to posts assigned one or more statuses.
Default: |
date |
The date the post was published, in the site's timezone. |
date_gmt |
The date the post was published, as GMT. |
slug |
An alphanumeric identifier for the post unique to its type. |
status |
A named status for the post. One of: |
password |
A password to protect access to the content and excerpt. |
parent |
The ID for the parent of the post. |
title |
The title for the post. |
content |
The content for the post. |
author |
The ID for the author of the post. |
excerpt |
The excerpt for the post. |
featured_media |
The ID of the featured media for the post. |
comment_status |
Whether or not comments are open on the post. One of: |
ping_status |
Whether or not the post can be pinged. One of: |
menu_order |
The order of the post in relation to other posts. |
meta |
Meta fields. |
template |
The theme file to use to display the post. |
POST /wp/v2/pages
GET /wp/v2/pages/<id>
Query this endpoint to retrieve a specific page record.
$ curl https://example.com/wp-json/wp/v2/pages/<id>
id |
Unique identifier for the post. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
password |
The password for the post if it is password protected. |
id |
Unique identifier for the post. |
date |
The date the post was published, in the site's timezone. |
date_gmt |
The date the post was published, as GMT. |
slug |
An alphanumeric identifier for the post unique to its type. |
status |
A named status for the post. One of: |
password |
A password to protect access to the content and excerpt. |
parent |
The ID for the parent of the post. |
title |
The title for the post. |
content |
The content for the post. |
author |
The ID for the author of the post. |
excerpt |
The excerpt for the post. |
featured_media |
The ID of the featured media for the post. |
comment_status |
Whether or not comments are open on the post. One of: |
ping_status |
Whether or not the post can be pinged. One of: |
menu_order |
The order of the post in relation to other posts. |
meta |
Meta fields. |
template |
The theme file to use to display the post. |
POST /wp/v2/pages/<id>
id |
Unique identifier for the post. |
force |
Whether to bypass Trash and force deletion. |
DELETE /wp/v2/pages/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/pages/<id>
The schema defines all the fields that exist within a pattern directory item record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
id
|
The pattern ID. JSON data type: integer Context: |
title
|
The pattern title, in human readable format. JSON data type: string Context: |
content
|
The pattern content. JSON data type: string Context: |
categories
|
The pattern's category slugs. JSON data type: array Context: |
keywords
|
The pattern's keywords. JSON data type: array Context: |
description
|
A description of the pattern. JSON data type: string Context: |
viewport_width
|
The preferred width of the viewport when previewing a pattern, in pixels. JSON data type: integer Context: |
block_types
|
The block types which can use this pattern. JSON data type: array Context: |
Query this endpoint to retrieve a collection of pattern directory items. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/pattern-directory/patterns
$ curl https://example.com/wp-json/wp/v2/pattern-directory/patterns
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
search |
Limit results to those matching a string. |
category |
Limit results to those matching a category ID. |
keyword |
Limit results to those matching a keyword ID. |
slug |
Limit results to those matching a pattern (slug). |
offset |
Offset the result set by a specific number of items. |
order |
Order sort attribute ascending or descending.
Default: One of: |
orderby |
Sort collection by post attribute.
Default: One of: |
The schema defines all the fields that exist within a plugin record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
plugin
|
The plugin file. JSON data type: string Read only Context: |
status
|
The plugin activation status. JSON data type: string Context: One of: |
name
|
The plugin name. JSON data type: string Read only Context: |
plugin_uri
|
The plugin's website address. JSON data type: string, Format: uri Read only Context: |
author
|
The plugin author. JSON data type: object Read only Context: |
author_uri
|
Plugin author's website address. JSON data type: string, Format: uri Read only Context: |
description
|
The plugin description. JSON data type: object Read only Context: |
version
|
The plugin version number. JSON data type: string Read only Context: |
network_only
|
Whether the plugin can only be activated network-wide. JSON data type: boolean Read only Context: |
requires_wp
|
Minimum required version of WordPress. JSON data type: string Read only Context: |
requires_php
|
Minimum required version of PHP. JSON data type: string Read only Context: |
textdomain
|
The plugin's text domain. JSON data type: string Read only Context: |
GET /wp/v2/plugins
Query this endpoint to retrieve a specific plugin record.
$ curl https://example.com/wp-json/wp/v2/plugins
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
search |
Limit results to those matching a string. |
status |
Limits results to plugins with the given status. |
slug |
WordPress.org plugin directory slug. Required: 1 |
status |
The plugin activation status.
Default: One of: |
POST /wp/v2/plugins
GET /wp/v2/plugins/<plugin>?)
Query this endpoint to retrieve a specific plugin record.
$ curl https://example.com/wp-json/wp/v2/plugins/<plugin>?)
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
plugin |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
plugin |
|
status |
The plugin activation status. One of: |
POST /wp/v2/plugins/<plugin>?)
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
plugin |
DELETE /wp/v2/plugins/<plugin>?)
$ curl -X DELETE https://example.com/wp-json/wp/v2/plugins/<plugin>?)
The schema defines all the fields that exist within a post revision record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
author
|
The ID for the author of the revision. JSON data type: integer Context: |
date
|
The date the revision was published, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
date_gmt
|
The date the revision was published, as GMT. JSON data type: string, Format: datetime (details) Context: |
guid
|
The globally unique identifier for the post. JSON data type: object Read only Context: |
id
|
Unique identifier for the revision. JSON data type: integer Context: |
modified
|
The date the revision was last modified, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
modified_gmt
|
The date the revision was last modified, as GMT. JSON data type: string, Format: datetime (details) Context: |
parent
|
The ID for the parent of the revision. JSON data type: integer Context: |
slug
|
An alphanumeric identifier for the revision unique to its type. JSON data type: string Context: |
title
|
The title for the post. JSON data type: object Context: |
content
|
The content for the post. JSON data type: object Context: |
excerpt
|
The excerpt for the post. JSON data type: object Context: |
Query this endpoint to retrieve a collection of post revisions. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/posts/<parent>/revisions
$ curl https://example.com/wp-json/wp/v2/posts/<parent>/revisions
parent |
The ID for the parent of the revision. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
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: One of: |
orderby |
Sort collection by object attribute.
Default: One of: |
GET /wp/v2/posts/<parent>/revisions/<id>
Query this endpoint to retrieve a specific post revision record.
$ curl https://example.com/wp-json/wp/v2/posts/<parent>/revisions/<id>
parent |
The ID for the parent of the revision. |
id |
Unique identifier for the revision. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
parent |
The ID for the parent of the revision. |
id |
Unique identifier for the revision. |
force |
Required to be true, as revisions do not support trashing. |
DELETE /wp/v2/posts/<parent>/revisions/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/posts/<parent>/revisions/<id>
GET /wp/v2/posts/<id>/autosaves
Query this endpoint to retrieve a specific post revision record.
$ curl https://example.com/wp-json/wp/v2/posts/<id>/autosaves
parent |
The ID for the parent of the autosave. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
parent |
The ID for the parent of the autosave. |
date |
The date the post was published, in the site's timezone. |
date_gmt |
The date the post was published, as GMT. |
slug |
An alphanumeric identifier for the post unique to its type. |
status |
A named status for the post. One of: |
password |
A password to protect access to the content and excerpt. |
title |
The title for the post. |
content |
The content for the post. |
author |
The ID for the author of the post. |
excerpt |
The excerpt for the post. |
featured_media |
The ID of the featured media for the post. |
comment_status |
Whether or not comments are open on the post. One of: |
ping_status |
Whether or not the post can be pinged. One of: |
format |
The format for the post. One of: |
meta |
Meta fields. |
sticky |
Whether or not the post should be treated as sticky. |
template |
The theme file to use to display the post. |
categories |
The terms assigned to the post in the category taxonomy. |
tags |
The terms assigned to the post in the post_tag taxonomy. |
POST /wp/v2/posts/<id>/autosaves
GET /wp/v2/posts/<parent>/autosaves/<id>
Query this endpoint to retrieve a specific post revision record.
$ curl https://example.com/wp-json/wp/v2/posts/<parent>/autosaves/<id>
parent |
The ID for the parent of the autosave. |
id |
The ID for the autosave. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
The schema defines all the fields that exist within a status record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
name
|
The title for the status. JSON data type: string Read only Context: |
private
|
Whether posts with this status should be private. JSON data type: boolean Read only Context: |
protected
|
Whether posts with this status should be protected. JSON data type: boolean Read only Context: |
public
|
Whether posts of this status should be shown in the front end of the site. JSON data type: boolean Read only Context: |
queryable
|
Whether posts with this status should be publicly-queryable. JSON data type: boolean Read only Context: |
show_in_list
|
Whether to include posts in the edit listing for their post type. JSON data type: boolean Read only Context: |
slug
|
An alphanumeric identifier for the status. JSON data type: string Read only Context: |
date_floating
|
Whether posts of this status may have floating published dates. JSON data type: boolean Read only Context: |
GET /wp/v2/statuses
Query this endpoint to retrieve a specific status record.
$ curl https://example.com/wp-json/wp/v2/statuses
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
GET /wp/v2/statuses/<status>
Query this endpoint to retrieve a specific status record.
$ curl https://example.com/wp-json/wp/v2/statuses/<status>
status |
An alphanumeric identifier for the status. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
The schema defines all the fields that exist within a type record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
capabilities
|
All capabilities used by the post type. JSON data type: object Read only Context: |
description
|
A human-readable description of the post type. JSON data type: string Read only Context: |
hierarchical
|
Whether or not the post type should have children. JSON data type: boolean Read only Context: |
viewable
|
Whether or not the post type can be viewed. JSON data type: boolean Read only Context: |
labels
|
Human-readable labels for the post type for various contexts. JSON data type: object Read only Context: |
name
|
The title for the post type. JSON data type: string Read only Context: |
slug
|
An alphanumeric identifier for the post type. JSON data type: string Read only Context: |
supports
|
All features, supported by the post type. JSON data type: object Read only Context: |
has_archive
|
If the value is a string, the value will be used as the archive slug. If the value is false the post type has no archive. JSON data type: string or boolean Read only Context: |
taxonomies
|
Taxonomies associated with post type. JSON data type: array Read only Context: |
rest_base
|
REST base route for the post type. JSON data type: string Read only Context: |
rest_namespace
|
REST route's namespace for the post type. JSON data type: string Read only Context: |
visibility
|
The visibility settings for the post type. JSON data type: object Read only Context: |
icon
|
The icon for the post type. JSON data type: string or null Read only Context: |
GET /wp/v2/types
Query this endpoint to retrieve a specific type record.
$ curl https://example.com/wp-json/wp/v2/types
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
GET /wp/v2/types/<type>
Query this endpoint to retrieve a specific type record.
$ curl https://example.com/wp-json/wp/v2/types/<type>
type |
An alphanumeric identifier for the post type. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
The schema defines all the fields that exist within a post record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
date
|
The date the post was published, in the site's timezone. JSON data type: string or null, Format: datetime (details) Context: |
date_gmt
|
The date the post was published, as GMT. JSON data type: string or null, Format: datetime (details) Context: |
guid
|
The globally unique identifier for the post. JSON data type: object Read only Context: |
id
|
Unique identifier for the post. JSON data type: integer Read only Context: |
link
|
URL to the post. JSON data type: string, Format: uri Read only Context: |
modified
|
The date the post was last modified, in the site's timezone. JSON data type: string, Format: datetime (details) Read only Context: |
modified_gmt
|
The date the post was last modified, as GMT. JSON data type: string, Format: datetime (details) Read only Context: |
slug
|
An alphanumeric identifier for the post unique to its type. JSON data type: string Context: |
status
|
A named status for the post. JSON data type: string Context: One of: |
type
|
Type of post. JSON data type: string Read only Context: |
password
|
A password to protect access to the content and excerpt. JSON data type: string Context: |
permalink_template
|
Permalink template for the post. JSON data type: string Read only Context: |
generated_slug
|
Slug automatically generated from the post title. JSON data type: string Read only Context: |
title
|
The title for the post. JSON data type: object Context: |
content
|
The content for the post. JSON data type: object Context: |
author
|
The ID for the author of the post. JSON data type: integer Context: |
excerpt
|
The excerpt for the post. JSON data type: object Context: |
featured_media
|
The ID of the featured media for the post. JSON data type: integer Context: |
comment_status
|
Whether or not comments are open on the post. JSON data type: string Context: One of: |
ping_status
|
Whether or not the post can be pinged. JSON data type: string Context: One of: |
format
|
The format for the post. JSON data type: string Context: One of: |
meta
|
Meta fields. JSON data type: object Context: |
sticky
|
Whether or not the post should be treated as sticky. JSON data type: boolean Context: |
template
|
The theme file to use to display the post. JSON data type: string Context: |
categories
|
The terms assigned to the post in the category taxonomy. JSON data type: array Context: |
tags
|
The terms assigned to the post in the post_tag taxonomy. JSON data type: array Context: |
Query this endpoint to retrieve a collection of posts. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/posts
$ curl https://example.com/wp-json/wp/v2/posts
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
search |
Limit results to those matching a string. |
after |
Limit response to posts published after a given ISO8601 compliant date. |
modified_after |
Limit response to posts modified 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. |
modified_before |
Limit response to posts modified 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: One of: |
orderby |
Sort collection by post attribute.
Default: One of: |
search_columns |
Array of column names to be searched. |
slug |
Limit result set to posts with one or more specific slugs. |
status |
Limit result set to posts assigned one or more statuses.
Default: |
tax_relation |
Limit result set based on relationship between multiple taxonomies. One of: |
categories |
Limit result set to items with specific terms assigned in the categories taxonomy. |
categories_exclude |
Limit result set to items except those with specific terms assigned in the categories taxonomy. |
tags |
Limit result set to items with specific terms assigned in the tags taxonomy. |
tags_exclude |
Limit result set to items except those with specific terms assigned in the tags taxonomy. |
sticky |
Limit result set to items that are sticky. |
date |
The date the post was published, in the site's timezone. |
date_gmt |
The date the post was published, as GMT. |
slug |
An alphanumeric identifier for the post unique to its type. |
status |
A named status for the post. One of: |
password |
A password to protect access to the content and excerpt. |
title |
The title for the post. |
content |
The content for the post. |
author |
The ID for the author of the post. |
excerpt |
The excerpt for the post. |
featured_media |
The ID of the featured media for the post. |
comment_status |
Whether or not comments are open on the post. One of: |
ping_status |
Whether or not the post can be pinged. One of: |
format |
The format for the post. One of: |
meta |
Meta fields. |
sticky |
Whether or not the post should be treated as sticky. |
template |
The theme file to use to display the post. |
categories |
The terms assigned to the post in the category taxonomy. |
tags |
The terms assigned to the post in the post_tag taxonomy. |
POST /wp/v2/posts
GET /wp/v2/posts/<id>
Query this endpoint to retrieve a specific post record.
$ curl https://example.com/wp-json/wp/v2/posts/<id>
id |
Unique identifier for the post. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
password |
The password for the post if it is password protected. |
id |
Unique identifier for the post. |
date |
The date the post was published, in the site's timezone. |
date_gmt |
The date the post was published, as GMT. |
slug |
An alphanumeric identifier for the post unique to its type. |
status |
A named status for the post. One of: |
password |
A password to protect access to the content and excerpt. |
title |
The title for the post. |
content |
The content for the post. |
author |
The ID for the author of the post. |
excerpt |
The excerpt for the post. |
featured_media |
The ID of the featured media for the post. |
comment_status |
Whether or not comments are open on the post. One of: |
ping_status |
Whether or not the post can be pinged. One of: |
format |
The format for the post. One of: |
meta |
Meta fields. |
sticky |
Whether or not the post should be treated as sticky. |
template |
The theme file to use to display the post. |
categories |
The terms assigned to the post in the category taxonomy. |
tags |
The terms assigned to the post in the post_tag taxonomy. |
POST /wp/v2/posts/<id>
$ curl -X POST https://example.com/wp-json/wp/v2/posts/<id> -d '{"title":"My New Title"}'
id |
Unique identifier for the post. |
force |
Whether to bypass Trash and force deletion. |
DELETE /wp/v2/posts/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/posts/<id>
The schema defines all the fields that exist within a Rendered Block record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
rendered
|
The rendered block. JSON data type: string Context: |
name |
Unique registered name for the block. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
attributes |
Attributes for the block. |
post_id |
ID of the post context. |
POST /wp/v2/block-renderer/<name>
The schema defines all the fields that exist within a search result record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
id
|
Unique identifier for the object. JSON data type: integer or string Read only Context: |
title
|
The title for the object. JSON data type: string Read only Context: |
url
|
URL to the object. JSON data type: string, Format: uri Read only Context: |
type
|
Object type. JSON data type: string Read only Context: One of: |
subtype
|
Object subtype. JSON data type: string Read only Context: One of: |
Query this endpoint to retrieve a collection of search results. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/search
$ curl https://example.com/wp-json/wp/v2/search
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
search |
Limit results to those matching a string. |
type |
Limit results to items of an object type.
Default: One of: |
subtype |
Limit results to items of one or more object subtypes.
Default: |
exclude |
Ensure result set excludes specific IDs. |
include |
Limit result set to specific IDs. |
The schema defines all the fields that exist within a Site Setting record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
title
|
Site title. JSON data type: string Context: |
description
|
Site tagline. JSON data type: string Context: |
url
|
Site URL. JSON data type: string, Format: uri Context: |
email
|
This address is used for admin purposes, like new user notification. JSON data type: string, Format: email Context: |
timezone
|
A city in the same timezone as you. JSON data type: string Context: |
date_format
|
A date format for all date strings. JSON data type: string Context: |
time_format
|
A time format for all time strings. JSON data type: string Context: |
start_of_week
|
A day number of the week that the week should start on. JSON data type: integer Context: |
language
|
WordPress locale code. JSON data type: string Context: |
use_smilies
|
Convert emoticons like :-) and :-P to graphics on display. JSON data type: boolean Context: |
default_category
|
Default post category. JSON data type: integer Context: |
default_post_format
|
Default post format. JSON data type: string Context: |
posts_per_page
|
Blog pages show at most. JSON data type: integer Context: |
show_on_front
|
What to show on the front page JSON data type: string Context: |
page_on_front
|
The ID of the page that should be displayed on the front page JSON data type: integer Context: |
page_for_posts
|
The ID of the page that should display the latest posts JSON data type: integer Context: |
default_ping_status
|
Allow link notifications from other blogs (pingbacks and trackbacks) on new articles. JSON data type: string Context: One of: |
default_comment_status
|
Allow people to submit comments on new posts. JSON data type: string Context: One of: |
site_logo
|
Site logo. JSON data type: integer Context: |
site_icon
|
Site icon. JSON data type: integer Context: |
GET /wp/v2/settings
Query this endpoint to retrieve a specific Site Setting record.
$ curl https://example.com/wp-json/wp/v2/settings
There are no arguments for this endpoint.
title |
Site title. |
description |
Site tagline. |
url |
Site URL. |
email |
This address is used for admin purposes, like new user notification. |
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. |
show_on_front |
What to show on the front page |
page_on_front |
The ID of the page that should be displayed on the front page |
page_for_posts |
The ID of the page that should display the latest posts |
default_ping_status |
Allow link notifications from other blogs (pingbacks and trackbacks) on new articles. One of: |
default_comment_status |
Allow people to submit comments on new posts. One of: |
site_logo |
Site logo. |
site_icon |
Site icon. |
POST /wp/v2/settings
The schema defines all the fields that exist within a sidebar record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
id
|
ID of sidebar. JSON data type: string Read only Context: |
name
|
Unique name identifying the sidebar. JSON data type: string Read only Context: |
description
|
Description of sidebar. JSON data type: string Read only Context: |
class
|
Extra CSS class to assign to the sidebar in the Widgets interface. JSON data type: string Read only Context: |
before_widget
|
HTML content to prepend to each widget's HTML output when assigned to this sidebar. Default is an opening list item element. JSON data type: string Read only Context: |
after_widget
|
HTML content to append to each widget's HTML output when assigned to this sidebar. Default is a closing list item element. JSON data type: string Read only Context: |
before_title
|
HTML content to prepend to the sidebar title when displayed. Default is an opening h2 element. JSON data type: string Read only Context: |
after_title
|
HTML content to append to the sidebar title when displayed. Default is a closing h2 element. JSON data type: string Read only Context: |
status
|
Status of sidebar. JSON data type: string Read only Context: One of: |
widgets
|
Nested widgets. JSON data type: array Context: |
GET /wp/v2/sidebars
Query this endpoint to retrieve a specific sidebar record.
$ curl https://example.com/wp-json/wp/v2/sidebars
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
GET /wp/v2/sidebars/<id>
Query this endpoint to retrieve a specific sidebar record.
$ curl https://example.com/wp-json/wp/v2/sidebars/<id>
id |
The id of a registered sidebar |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
POST /wp/v2/sidebars/<id>
The schema defines all the fields that exist within a tag record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
id
|
Unique identifier for the term. JSON data type: integer Read only Context: |
count
|
Number of published posts for the term. JSON data type: integer Read only Context: |
description
|
HTML description of the term. JSON data type: string Context: |
link
|
URL of the term. JSON data type: string, Format: uri Read only Context: |
name
|
HTML title for the term. JSON data type: string Context: |
slug
|
An alphanumeric identifier for the term unique to its type. JSON data type: string Context: |
taxonomy
|
Type attribution for the term. JSON data type: string Read only Context: One of: |
meta
|
Meta fields. JSON data type: object Context: |
Query this endpoint to retrieve a collection of tags. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/tags
$ curl https://example.com/wp-json/wp/v2/tags
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
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: One of: |
orderby |
Sort collection by term attribute.
Default: One of: |
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. |
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. |
POST /wp/v2/tags
GET /wp/v2/tags/<id>
Query this endpoint to retrieve a specific tag record.
$ curl https://example.com/wp-json/wp/v2/tags/<id>
id |
Unique identifier for the term. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
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. |
POST /wp/v2/tags/<id>
id |
Unique identifier for the term. |
force |
Required to be true, as terms do not support trashing. |
DELETE /wp/v2/tags/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/tags/<id>
The schema defines all the fields that exist within a taxonomy record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
capabilities
|
All capabilities used by the taxonomy. JSON data type: object Read only Context: |
description
|
A human-readable description of the taxonomy. JSON data type: string Read only Context: |
hierarchical
|
Whether or not the taxonomy should have children. JSON data type: boolean Read only Context: |
labels
|
Human-readable labels for the taxonomy for various contexts. JSON data type: object Read only Context: |
name
|
The title for the taxonomy. JSON data type: string Read only Context: |
slug
|
An alphanumeric identifier for the taxonomy. JSON data type: string Read only Context: |
show_cloud
|
Whether or not the term cloud should be displayed. JSON data type: boolean Read only Context: |
types
|
Types associated with the taxonomy. JSON data type: array Read only Context: |
rest_base
|
REST base route for the taxonomy. JSON data type: string Read only Context: |
rest_namespace
|
REST namespace route for the taxonomy. JSON data type: string Read only Context: |
visibility
|
The visibility settings for the taxonomy. JSON data type: object Read only Context: |
GET /wp/v2/taxonomies
Query this endpoint to retrieve a specific taxonomy record.
$ curl https://example.com/wp-json/wp/v2/taxonomies
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
type |
Limit results to taxonomies associated with a specific post type. |
GET /wp/v2/taxonomies/<taxonomy>
Query this endpoint to retrieve a specific taxonomy record.
$ curl https://example.com/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: One of: |
The schema defines all the fields that exist within a theme record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
stylesheet
|
The theme's stylesheet. This uniquely identifies the theme. JSON data type: string Read only Context: |
template
|
The theme's template. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's stylesheet. JSON data type: string Read only Context: |
author
|
The theme author. JSON data type: object Read only Context: |
author_uri
|
The website of the theme author. JSON data type: object Read only Context: |
description
|
A description of the theme. JSON data type: object Read only Context: |
is_block_theme
|
Whether the theme is a block-based theme. JSON data type: boolean Read only Context: |
name
|
The name of the theme. JSON data type: object Read only Context: |
requires_php
|
The minimum PHP version required for the theme to work. JSON data type: string Read only Context: |
requires_wp
|
The minimum WordPress version required for the theme to work. JSON data type: string Read only Context: |
screenshot
|
The theme's screenshot URL. JSON data type: string, Format: uri Read only Context: |
tags
|
Tags indicating styles and features of the theme. JSON data type: object Read only Context: |
textdomain
|
The theme's text domain. JSON data type: string Read only Context: |
theme_supports
|
Features supported by this theme. JSON data type: object Read only Context: |
theme_uri
|
The URI of the theme's webpage. JSON data type: object Read only Context: |
version
|
The theme's current version. JSON data type: string Read only Context: |
status
|
A named status for the theme. JSON data type: string Context: One of: |
GET /wp/v2/themes
Query this endpoint to retrieve a specific theme record.
$ curl https://example.com/wp-json/wp/v2/themes
status |
Limit result set to themes assigned one or more statuses. |
GET /wp/v2/themes/<stylesheet>?)
Query this endpoint to retrieve a specific theme record.
$ curl https://example.com/wp-json/wp/v2/themes/<stylesheet>?)
stylesheet |
The theme's stylesheet. This uniquely identifies the theme. |
The schema defines all the fields that exist within a user record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
id
|
Unique identifier for the user. JSON data type: integer Read only Context: |
username
|
Login name for the user. JSON data type: string Context: |
name
|
Display name for the user. JSON data type: string Context: |
first_name
|
First name for the user. JSON data type: string Context: |
last_name
|
Last name for the user. JSON data type: string Context: |
email
|
The email address for the user. JSON data type: string, Format: email Context: |
url
|
URL of the user. JSON data type: string, Format: uri Context: |
description
|
Description of the user. JSON data type: string Context: |
link
|
Author URL of the user. JSON data type: string, Format: uri Read only Context: |
locale
|
Locale for the user. JSON data type: string Context: One of: |
nickname
|
The nickname for the user. JSON data type: string Context: |
slug
|
An alphanumeric identifier for the user. JSON data type: string Context: |
registered_date
|
Registration date for the user. JSON data type: string, Format: datetime (details) Read only Context: |
roles
|
Roles assigned to the user. JSON data type: array Context: |
password
|
Password for the user (never included). JSON data type: string Context: |
capabilities
|
All capabilities assigned to the user. JSON data type: object Read only Context: |
extra_capabilities
|
Any extra capabilities assigned to the user. JSON data type: object Read only Context: |
avatar_urls
|
Avatar URLs for the user. JSON data type: object Read only Context: |
meta
|
Meta fields. JSON data type: object Context: |
Query this endpoint to retrieve a collection of users. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/users
$ curl https://example.com/wp-json/wp/v2/users
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
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: One of: |
orderby |
Sort collection by user attribute.
Default: One of: |
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. |
capabilities |
Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability. |
who |
Limit result set to users who are considered authors. One of: |
has_published_posts |
Limit result set to users who have published posts. |
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: |
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. |
POST /wp/v2/users
GET /wp/v2/users/<id>
Query this endpoint to retrieve a specific user record.
$ curl https://example.com/wp-json/wp/v2/users/<id>
id |
Unique identifier for the user. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
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: |
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. |
POST /wp/v2/users/<id>
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 |
DELETE /wp/v2/users/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/users/<id>
GET /wp/v2/users/me
Query this endpoint to retrieve a specific user record.
$ curl https://example.com/wp-json/wp/v2/users/me
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
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: |
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. |
POST /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 |
DELETE /wp/v2/users/me
$ curl -X DELETE https://example.com/wp-json/wp/v2/users/me
The schema defines all the fields that exist within a widget type record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
id
|
Unique slug identifying the widget type. JSON data type: string Read only Context: |
name
|
Human-readable name identifying the widget type. JSON data type: string Read only Context: |
description
|
Description of the widget. JSON data type: string Context: |
is_multi
|
Whether the widget supports multiple instances JSON data type: boolean Read only Context: |
classname
|
Class name JSON data type: string Read only Context: |
GET /wp/v2/widget-types
Query this endpoint to retrieve a specific widget type record.
$ curl https://example.com/wp-json/wp/v2/widget-types
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
GET /wp/v2/widget-types/<id>
Query this endpoint to retrieve a specific widget type record.
$ curl https://example.com/wp-json/wp/v2/widget-types/<id>
id |
The widget type id. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
The schema defines all the fields that exist within a widget record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
id
|
Unique identifier for the widget. JSON data type: string Context: |
id_base
|
The type of the widget. Corresponds to ID in widget-types endpoint. JSON data type: string Context: |
sidebar
|
The sidebar the widget belongs to. JSON data type: string Context: |
rendered
|
HTML representation of the widget. JSON data type: string Read only Context: |
rendered_form
|
HTML representation of the widget admin form. JSON data type: string Read only Context: |
instance
|
Instance settings of the widget, if supported. JSON data type: object Context: |
form_data
|
URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only. JSON data type: string Context: |
GET /wp/v2/widgets
Query this endpoint to retrieve a specific widget record.
$ curl https://example.com/wp-json/wp/v2/widgets
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
sidebar |
The sidebar to return widgets for. |
id |
Unique identifier for the widget. |
id_base |
The type of the widget. Corresponds to ID in widget-types endpoint. |
sidebar |
The sidebar the widget belongs to. Required: 1
Default: |
instance |
Instance settings of the widget, if supported. |
form_data |
URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only. |
POST /wp/v2/widgets
GET /wp/v2/widgets/<id>
Query this endpoint to retrieve a specific widget record.
$ curl https://example.com/wp-json/wp/v2/widgets/<id>
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
id |
Unique identifier for the widget. |
id_base |
The type of the widget. Corresponds to ID in widget-types endpoint. |
sidebar |
The sidebar the widget belongs to. |
instance |
Instance settings of the widget, if supported. |
form_data |
URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only. |
POST /wp/v2/widgets/<id>
force |
Whether to force removal of the widget, or move it to the inactive sidebar. |
DELETE /wp/v2/widgets/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/widgets/<id>
The schema defines all the fields that exist within a wp site health test record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
test
|
The name of the test being run. JSON data type: string Read only Context: |
label
|
A label describing the test. JSON data type: string Read only Context: |
status
|
The status of the test. JSON data type: string Read only Context: One of: |
badge
|
The category this test is grouped in. JSON data type: object Read only Context: |
description
|
A more descriptive explanation of what the test looks for, and why it is important for the user. JSON data type: string Read only Context: |
actions
|
HTML containing an action to direct the user to where they can resolve the issue. JSON data type: string Read only Context: |
GET /wp-site-health/v1/tests/background-updates
Query this endpoint to retrieve a specific wp site health test record.
$ curl https://example.com/wp-json/wp-site-health/v1/tests/background-updates
There are no arguments for this endpoint.
GET /wp-site-health/v1/tests/loopback-requests
Query this endpoint to retrieve a specific wp site health test record.
$ curl https://example.com/wp-json/wp-site-health/v1/tests/loopback-requests
There are no arguments for this endpoint.
GET /wp-site-health/v1/tests/https-status
Query this endpoint to retrieve a specific wp site health test record.
$ curl https://example.com/wp-json/wp-site-health/v1/tests/https-status
There are no arguments for this endpoint.
GET /wp-site-health/v1/tests/dotorg-communication
Query this endpoint to retrieve a specific wp site health test record.
$ curl https://example.com/wp-json/wp-site-health/v1/tests/dotorg-communication
There are no arguments for this endpoint.
GET /wp-site-health/v1/tests/authorization-header
Query this endpoint to retrieve a specific wp site health test record.
$ curl https://example.com/wp-json/wp-site-health/v1/tests/authorization-header
There are no arguments for this endpoint.
The schema defines all the fields that exist within a global_styles revision record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
author
|
The ID for the author of the revision. JSON data type: integer Context: |
date
|
The date the revision was published, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
date_gmt
|
The date the revision was published, as GMT. JSON data type: string, Format: datetime (details) Context: |
id
|
Unique identifier for the revision. JSON data type: integer Context: |
modified
|
The date the revision was last modified, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
modified_gmt
|
The date the revision was last modified, as GMT. JSON data type: string, Format: datetime (details) Context: |
parent
|
The ID for the parent of the revision. JSON data type: integer Context: |
styles
|
Global styles. JSON data type: object Context: |
settings
|
Global settings. JSON data type: object Context: |
Query this endpoint to retrieve a collection of global_styles revisions. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/global-styles/<parent>/revisions
$ curl https://example.com/wp-json/wp/v2/global-styles/<parent>/revisions
parent |
The ID for the parent of the revision. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set. |
offset |
Offset the result set by a specific number of items. |
The schema defines all the fields that exist within a global_styles record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
id
|
ID of global styles config. JSON data type: string Read only Context: |
styles
|
Global styles. JSON data type: object Context: |
settings
|
Global settings. JSON data type: object Context: |
title
|
Title of the global styles variation. JSON data type: object or string Context: |
GET /wp/v2/global-styles/<id>
Query this endpoint to retrieve a specific global_styles record.
$ curl https://example.com/wp-json/wp/v2/global-styles/<id>
id |
The id of a template |
styles |
Global styles. |
settings |
Global settings. |
title |
Title of the global styles variation. |
POST /wp/v2/global-styles/<id>
The schema defines all the fields that exist within a navigation revision record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
author
|
The ID for the author of the revision. JSON data type: integer Context: |
date
|
The date the revision was published, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
date_gmt
|
The date the revision was published, as GMT. JSON data type: string, Format: datetime (details) Context: |
guid
|
The globally unique identifier for the post. JSON data type: object Read only Context: |
id
|
Unique identifier for the revision. JSON data type: integer Context: |
modified
|
The date the revision was last modified, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
modified_gmt
|
The date the revision was last modified, as GMT. JSON data type: string, Format: datetime (details) Context: |
parent
|
The ID for the parent of the revision. JSON data type: integer Context: |
slug
|
An alphanumeric identifier for the revision unique to its type. JSON data type: string Context: |
title
|
The title for the post. JSON data type: object Context: |
content
|
The content for the post. JSON data type: object Context: |
Query this endpoint to retrieve a collection of navigation revisions. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/navigation/<parent>/revisions
$ curl https://example.com/wp-json/wp/v2/navigation/<parent>/revisions
parent |
The ID for the parent of the revision. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
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: One of: |
orderby |
Sort collection by object attribute.
Default: One of: |
GET /wp/v2/navigation/<parent>/revisions/<id>
Query this endpoint to retrieve a specific navigation revision record.
$ curl https://example.com/wp-json/wp/v2/navigation/<parent>/revisions/<id>
parent |
The ID for the parent of the revision. |
id |
Unique identifier for the revision. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
parent |
The ID for the parent of the revision. |
id |
Unique identifier for the revision. |
force |
Required to be true, as revisions do not support trashing. |
DELETE /wp/v2/navigation/<parent>/revisions/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/navigation/<parent>/revisions/<id>
GET /wp/v2/navigation/<id>/autosaves
Query this endpoint to retrieve a specific navigation revision record.
$ curl https://example.com/wp-json/wp/v2/navigation/<id>/autosaves
parent |
The ID for the parent of the autosave. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
parent |
The ID for the parent of the autosave. |
date |
The date the post was published, in the site's timezone. |
date_gmt |
The date the post was published, as GMT. |
slug |
An alphanumeric identifier for the post unique to its type. |
status |
A named status for the post. One of: |
password |
A password to protect access to the content and excerpt. |
title |
The title for the post. |
content |
The content for the post. |
template |
The theme file to use to display the post. |
POST /wp/v2/navigation/<id>/autosaves
GET /wp/v2/navigation/<parent>/autosaves/<id>
Query this endpoint to retrieve a specific navigation revision record.
$ curl https://example.com/wp-json/wp/v2/navigation/<parent>/autosaves/<id>
parent |
The ID for the parent of the autosave. |
id |
The ID for the autosave. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
The schema defines all the fields that exist within a navigation record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
date
|
The date the post was published, in the site's timezone. JSON data type: string or null, Format: datetime (details) Context: |
date_gmt
|
The date the post was published, as GMT. JSON data type: string or null, Format: datetime (details) Context: |
guid
|
The globally unique identifier for the post. JSON data type: object Read only Context: |
id
|
Unique identifier for the post. JSON data type: integer Read only Context: |
link
|
URL to the post. JSON data type: string, Format: uri Read only Context: |
modified
|
The date the post was last modified, in the site's timezone. JSON data type: string, Format: datetime (details) Read only Context: |
modified_gmt
|
The date the post was last modified, as GMT. JSON data type: string, Format: datetime (details) Read only Context: |
slug
|
An alphanumeric identifier for the post unique to its type. JSON data type: string Context: |
status
|
A named status for the post. JSON data type: string Context: One of: |
type
|
Type of post. JSON data type: string Read only Context: |
password
|
A password to protect access to the content and excerpt. JSON data type: string Context: |
title
|
The title for the post. JSON data type: object Context: |
content
|
The content for the post. JSON data type: object Context: |
template
|
The theme file to use to display the post. JSON data type: string Context: |
Query this endpoint to retrieve a collection of navigations. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/navigation
$ curl https://example.com/wp-json/wp/v2/navigation
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
search |
Limit results to those matching a string. |
after |
Limit response to posts published after a given ISO8601 compliant date. |
modified_after |
Limit response to posts modified after a given ISO8601 compliant date. |
before |
Limit response to posts published before a given ISO8601 compliant date. |
modified_before |
Limit response to posts modified 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: One of: |
orderby |
Sort collection by post attribute.
Default: One of: |
search_columns |
Array of column names to be searched. |
slug |
Limit result set to posts with one or more specific slugs. |
status |
Limit result set to posts assigned one or more statuses.
Default: |
date |
The date the post was published, in the site's timezone. |
date_gmt |
The date the post was published, as GMT. |
slug |
An alphanumeric identifier for the post unique to its type. |
status |
A named status for the post. One of: |
password |
A password to protect access to the content and excerpt. |
title |
The title for the post. |
content |
The content for the post. |
template |
The theme file to use to display the post. |
POST /wp/v2/navigation
GET /wp/v2/navigation/<id>
Query this endpoint to retrieve a specific navigation record.
$ curl https://example.com/wp-json/wp/v2/navigation/<id>
id |
Unique identifier for the post. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
password |
The password for the post if it is password protected. |
id |
Unique identifier for the post. |
date |
The date the post was published, in the site's timezone. |
date_gmt |
The date the post was published, as GMT. |
slug |
An alphanumeric identifier for the post unique to its type. |
status |
A named status for the post. One of: |
password |
A password to protect access to the content and excerpt. |
title |
The title for the post. |
content |
The content for the post. |
template |
The theme file to use to display the post. |
POST /wp/v2/navigation/<id>
id |
Unique identifier for the post. |
force |
Whether to bypass Trash and force deletion. |
DELETE /wp/v2/navigation/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/navigation/<id>
The schema defines all the fields that exist within a template revision record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
author
|
The ID for the author of the revision. JSON data type: integer Context: |
date
|
The date the revision was published, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
date_gmt
|
The date the revision was published, as GMT. JSON data type: string, Format: datetime (details) Context: |
guid
|
GUID for the revision, as it exists in the database. JSON data type: string Context: |
id
|
Unique identifier for the revision. JSON data type: integer Context: |
modified
|
The date the revision was last modified, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
modified_gmt
|
The date the revision was last modified, as GMT. JSON data type: string, Format: datetime (details) Context: |
parent
|
The ID for the parent of the revision. JSON data type: integer Context: |
slug
|
An alphanumeric identifier for the revision unique to its type. JSON data type: string Context: |
title
|
Title of template. JSON data type: object or string Context: |
content
|
Content of template. JSON data type: object or string Context: |
Query this endpoint to retrieve a collection of template revisions. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/templates/<parent>/revisions
$ curl https://example.com/wp-json/wp/v2/templates/<parent>/revisions
parent |
The ID for the parent of the revision. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
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: One of: |
orderby |
Sort collection by object attribute.
Default: One of: |
GET /wp/v2/templates/<parent>/revisions/<id>
Query this endpoint to retrieve a specific template revision record.
$ curl https://example.com/wp-json/wp/v2/templates/<parent>/revisions/<id>
parent |
The ID for the parent of the revision. |
id |
Unique identifier for the revision. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
parent |
The ID for the parent of the revision. |
id |
Unique identifier for the revision. |
force |
Required to be true, as revisions do not support trashing. |
DELETE /wp/v2/templates/<parent>/revisions/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/templates/<parent>/revisions/<id>
GET /wp/v2/templates/<id>/autosaves
Query this endpoint to retrieve a specific template revision record.
$ curl https://example.com/wp-json/wp/v2/templates/<id>/autosaves
parent |
The ID for the parent of the autosave. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
parent |
The ID for the parent of the autosave. |
slug |
Unique slug identifying the template. |
theme |
Theme identifier for the template. |
type |
Type of template. |
content |
Content of template. |
title |
Title of template. |
description |
Description of template. |
status |
Status of template. One of: |
author |
The ID for the author of the template. |
POST /wp/v2/templates/<id>/autosaves
GET /wp/v2/templates/<parent>/autosaves/<id>
Query this endpoint to retrieve a specific template revision record.
$ curl https://example.com/wp-json/wp/v2/templates/<parent>/autosaves/<id>
parent |
The ID for the parent of the autosave. |
id |
The ID for the autosave. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
The schema defines all the fields that exist within a template_part revision record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
author
|
The ID for the author of the revision. JSON data type: integer Context: |
date
|
The date the revision was published, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
date_gmt
|
The date the revision was published, as GMT. JSON data type: string, Format: datetime (details) Context: |
guid
|
GUID for the revision, as it exists in the database. JSON data type: string Context: |
id
|
Unique identifier for the revision. JSON data type: integer Context: |
modified
|
The date the revision was last modified, in the site's timezone. JSON data type: string, Format: datetime (details) Context: |
modified_gmt
|
The date the revision was last modified, as GMT. JSON data type: string, Format: datetime (details) Context: |
parent
|
The ID for the parent of the revision. JSON data type: integer Context: |
slug
|
An alphanumeric identifier for the revision unique to its type. JSON data type: string Context: |
title
|
Title of template. JSON data type: object or string Context: |
content
|
Content of template. JSON data type: object or string Context: |
Query this endpoint to retrieve a collection of template_part revisions. The response you receive can be controlled and filtered using the URL query parameters below.
GET /wp/v2/template-parts/<parent>/revisions
$ curl https://example.com/wp-json/wp/v2/template-parts/<parent>/revisions
parent |
The ID for the parent of the revision. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
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: One of: |
orderby |
Sort collection by object attribute.
Default: One of: |
GET /wp/v2/template-parts/<parent>/revisions/<id>
Query this endpoint to retrieve a specific template_part revision record.
$ curl https://example.com/wp-json/wp/v2/template-parts/<parent>/revisions/<id>
parent |
The ID for the parent of the revision. |
id |
Unique identifier for the revision. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
parent |
The ID for the parent of the revision. |
id |
Unique identifier for the revision. |
force |
Required to be true, as revisions do not support trashing. |
DELETE /wp/v2/template-parts/<parent>/revisions/<id>
$ curl -X DELETE https://example.com/wp-json/wp/v2/template-parts/<parent>/revisions/<id>
GET /wp/v2/template-parts/<id>/autosaves
Query this endpoint to retrieve a specific template_part revision record.
$ curl https://example.com/wp-json/wp/v2/template-parts/<id>/autosaves
parent |
The ID for the parent of the autosave. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
parent |
The ID for the parent of the autosave. |
slug |
Unique slug identifying the template. |
theme |
Theme identifier for the template. |
type |
Type of template. |
content |
Content of template. |
title |
Title of template. |
description |
Description of template. |
status |
Status of template. One of: |
author |
The ID for the author of the template. |
area |
Where the template part is intended for use (header, footer, etc.) |
POST /wp/v2/template-parts/<id>/autosaves
GET /wp/v2/template-parts/<parent>/autosaves/<id>
Query this endpoint to retrieve a specific template_part revision record.
$ curl https://example.com/wp-json/wp/v2/template-parts/<parent>/autosaves/<id>
parent |
The ID for the parent of the autosave. |
id |
The ID for the autosave. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
The schema defines all the fields that exist within a template_part record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
id
|
ID of template. JSON data type: string Read only Context: |
slug
|
Unique slug identifying the template. JSON data type: string Context: |
theme
|
Theme identifier for the template. JSON data type: string Context: |
type
|
Type of template. JSON data type: string Context: |
source
|
Source of template JSON data type: string Read only Context: |
origin
|
Source of a customized template JSON data type: string Read only Context: |
content
|
Content of template. JSON data type: object or string Context: |
title
|
Title of template. JSON data type: object or string Context: |
description
|
Description of template. JSON data type: string Context: |
status
|
Status of template. JSON data type: string Context: One of: |
wp_id
|
Post ID. JSON data type: integer Read only Context: |
has_theme_file
|
Theme file exists. JSON data type: bool Read only Context: |
author
|
The ID for the author of the template. JSON data type: integer Context: |
modified
|
The date the template was last modified, in the site's timezone. JSON data type: string, Format: datetime (details) Read only Context: |
area
|
Where the template part is intended for use (header, footer, etc.) JSON data type: string Context: |
GET /wp/v2/template-parts
Query this endpoint to retrieve a specific template_part record.
$ curl https://example.com/wp-json/wp/v2/template-parts
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
wp_id |
Limit to the specified post id. |
area |
Limit to the specified template part area. |
post_type |
Post type to get the templates for. |
slug |
Unique slug identifying the template. Required: 1 |
theme |
Theme identifier for the template. |
type |
Type of template. |
content |
Content of template. |
title |
Title of template. |
description |
Description of template. |
status |
Status of template.
Default: One of: |
author |
The ID for the author of the template. |
area |
Where the template part is intended for use (header, footer, etc.) |
POST /wp/v2/template-parts
GET /wp/v2/template-parts/<id>?)[\/\w%-]+)
Query this endpoint to retrieve a specific template_part record.
$ curl https://example.com/wp-json/wp/v2/template-parts/<id>?)[\/\w%-]+)
id |
The id of a template |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
id |
The id of a template |
slug |
Unique slug identifying the template. |
theme |
Theme identifier for the template. |
type |
Type of template. |
content |
Content of template. |
title |
Title of template. |
description |
Description of template. |
status |
Status of template. One of: |
author |
The ID for the author of the template. |
area |
Where the template part is intended for use (header, footer, etc.) |
POST /wp/v2/template-parts/<id>?)[\/\w%-]+)
id |
The id of a template |
force |
Whether to bypass Trash and force deletion. |
DELETE /wp/v2/template-parts/<id>?)[\/\w%-]+)
$ curl -X DELETE https://example.com/wp-json/wp/v2/template-parts/<id>?)[\/\w%-]+)
The schema defines all the fields that exist within a template record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
id
|
ID of template. JSON data type: string Read only Context: |
slug
|
Unique slug identifying the template. JSON data type: string Context: |
theme
|
Theme identifier for the template. JSON data type: string Context: |
type
|
Type of template. JSON data type: string Context: |
source
|
Source of template JSON data type: string Read only Context: |
origin
|
Source of a customized template JSON data type: string Read only Context: |
content
|
Content of template. JSON data type: object or string Context: |
title
|
Title of template. JSON data type: object or string Context: |
description
|
Description of template. JSON data type: string Context: |
status
|
Status of template. JSON data type: string Context: One of: |
wp_id
|
Post ID. JSON data type: integer Read only Context: |
has_theme_file
|
Theme file exists. JSON data type: bool Read only Context: |
author
|
The ID for the author of the template. JSON data type: integer Context: |
modified
|
The date the template was last modified, in the site's timezone. JSON data type: string, Format: datetime (details) Read only Context: |
is_custom
|
Whether a template is a custom template. JSON data type: bool Read only Context: |
GET /wp/v2/templates
Query this endpoint to retrieve a specific template record.
$ curl https://example.com/wp-json/wp/v2/templates
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
wp_id |
Limit to the specified post id. |
area |
Limit to the specified template part area. |
post_type |
Post type to get the templates for. |
slug |
Unique slug identifying the template. Required: 1 |
theme |
Theme identifier for the template. |
type |
Type of template. |
content |
Content of template. |
title |
Title of template. |
description |
Description of template. |
status |
Status of template.
Default: One of: |
author |
The ID for the author of the template. |
POST /wp/v2/templates
GET /wp/v2/templates/<id>?)[\/\w%-]+)
Query this endpoint to retrieve a specific template record.
$ curl https://example.com/wp-json/wp/v2/templates/<id>?)[\/\w%-]+)
id |
The id of a template |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
id |
The id of a template |
slug |
Unique slug identifying the template. |
theme |
Theme identifier for the template. |
type |
Type of template. |
content |
Content of template. |
title |
Title of template. |
description |
Description of template. |
status |
Status of template. One of: |
author |
The ID for the author of the template. |
POST /wp/v2/templates/<id>?)[\/\w%-]+)
id |
The id of a template |
force |
Whether to bypass Trash and force deletion. |
DELETE /wp/v2/templates/<id>?)[\/\w%-]+)
$ curl -X DELETE https://example.com/wp-json/wp/v2/templates/<id>?)[\/\w%-]+)