Browse: Home / REST API Handbook / Reference / Posts

Posts Edit

Topics

Schema

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

string or null,
datetime (details)
 		The date the post was published, in the site's timezone.

Context: view, edit, embed
date_gmt

string or null,
datetime (details)
 		The date the post was published, as GMT.

Context: view, edit
guid

object 		The globally unique identifier for the post.

Read only

Context: view, edit
id

integer 		Unique identifier for the post.

Read only

Context: view, edit, embed
modified

string,
datetime (details)
 		The date the post was last modified, in the site's timezone.

Read only

Context: view, edit
modified_gmt

string,
datetime (details)
 		The date the post was last modified, as GMT.

Read only

Context: view, edit
slug

string 		An alphanumeric identifier for the post unique to its type.

Context: view, edit, embed
status

string 		A named status for the post.

Context: view, edit

One of: publish, future, draft, pending, private

type

string 		Type of post.

Read only

Context: view, edit, embed
password

string 		A password to protect access to the content and excerpt.

Context: edit
generated_slug

string 		Slug automatically generated from the post title.

Read only

Context: edit
title

object 		The title for the post.

Context: view, edit, embed
content

object 		The content for the post.

Context: view, edit
author

integer 		The ID for the author of the post.

Context: view, edit, embed
excerpt

object 		The excerpt for the post.

Context: view, edit, embed
comment_status

string 		Whether or not comments are open on the post.

Context: view, edit

One of: open, closed

ping_status

string 		Whether or not the post can be pinged.

Context: view, edit

One of: open, closed

format

string 		The format for the post.

Context: view, edit

One of: standard, aside, chat, gallery, link, image, quote, status, video, audio

meta

object 		Meta fields.

Context: view, edit
sticky

boolean 		Whether or not the post should be treated as sticky.

Context: view, edit
template

string 		The theme file to use to display the post.

Context: view, edit
categories

array 		The terms assigned to the post in the category taxonomy.

Context: view, edit
tags

array 		The terms assigned to the post in the post_tag taxonomy.

Context: view, edit

Top ↑

List Posts

Query this endpoint to retrieve a collection of posts. The response you receive can be controlled and filtered using the URL query parameters below.

Top ↑

Definition

GET /wp/v2/posts

Top ↑

Example Request

$ curl https://example.com/wp-json/wp/v2/posts

Top ↑

Arguments

context Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

page Current page of the collection.

Default: 1

per_page Maximum number of items to be returned in result set.

Default: 10

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: desc

One of: asc, desc

orderby Sort collection by post attribute.

Default: date

One of: author, date, id, include, modified, parent, relevance, slug, include_slugs, title

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: publish

tax_relation Limit result set based on relationship between multiple taxonomies.
One of: AND, OR
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.

Top ↑

Create a Post

Top ↑

Arguments

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: publish, future, draft, pending, private
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: open, closed
ping_status Whether or not the post can be pinged.
One of: open, closed
format The format for the post.
One of: standard, aside, chat, gallery, link, image, quote, status, video, audio
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.

Top ↑

Definition

POST /wp/v2/posts

Top ↑

Retrieve a Post

Top ↑

Definition & Example Request

GET /wp/v2/posts/<id>

Query this endpoint to retrieve a specific post record.

$ curl https://example.com/wp-json/wp/v2/posts/<id>

Top ↑

Arguments

id Unique identifier for the post.
context Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

password The password for the post if it is password protected.

Top ↑

Update a Post

Top ↑

Arguments

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: publish, future, draft, pending, private
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: open, closed
ping_status Whether or not the post can be pinged.
One of: open, closed
format The format for the post.
One of: standard, aside, chat, gallery, link, image, quote, status, video, audio
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.

Top ↑

Definition

POST /wp/v2/posts/<id>

Top ↑

Example Request

$ curl -X POST https://example.com/wp-json/wp/v2/posts/<id> -d '{"title":"My New Title"}'

Top ↑

Delete a Post

Top ↑

Arguments

id Unique identifier for the post.
force Whether to bypass Trash and force deletion.

Top ↑

Definition

DELETE /wp/v2/posts/<id>

Top ↑

Example Request

$ curl -X DELETE https://example.com/wp-json/wp/v2/posts/<id>