Pages

Schema Schema

The schema defines all the fields that exist for a page object.

date

string,
datetime (ISO8601)

The date the object was published, in the site’s timezone.

Context: view, edit, embed

date_gmt

string,
datetime (ISO8601)

The date the object was published, as GMT.

Context: view, edit

guid

object

The globally unique identifier for the object.

Read only

Context: view, edit

id

integer

Unique identifier for the object.

Read only

Context: view, edit, embed

modified

string,
datetime (ISO8601)

The date the object was last modified, in the site’s timezone.

Read only

Context: view, edit

modified_gmt

string,
datetime (ISO8601)

The date the object was last modified, as GMT.

Read only

Context: view, edit

slug

string

An alphanumeric identifier for the object unique to its type.

Context: view, edit, embed

status

string

A named status for the object.

Context: edit

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

type

string

Type of Post for the object.

Read only

Context: view, edit, embed

parent

integer

The id for the parent of the object.

Context: view, edit

title

object

The title for the object.

Context: view, edit, embed

content

object

The content for the object.

Context: view, edit

author

integer

The id for the author of the object.

Context: view, edit, embed

excerpt

object

The excerpt for the object.

Context: view, edit, embed

comment_status

string

Whether or not comments are open on the object.

Context: view, edit

One of: open, closed

ping_status

string

Whether or not the object can be pinged.

Context: view, edit

One of: open, closed

menu_order

integer

The order of the object in relation to other object of its type.

Context: view, edit

meta

object

Meta fields.

Context: view, edit

template

string

The theme file to use to display the object.

Context: view, edit

One of:

Example Request Example Request

$ curl -X OPTIONS -i http://demo.wp-api.org/wp-json/wp/v2/pages

Top ↑

List Pages List Pages

Top ↑

Arguments 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 resources published after a given ISO8601 compliant date.

author

Limit result set to posts assigned to specific authors.

Default:

author_exclude

Ensure result set excludes posts assigned to specific authors.

Default:

before

Limit response to resources published before a given ISO8601 compliant date.

exclude

Ensure result set excludes specific ids.

Default:

include

Limit result set to specific ids.

Default:

menu_order

Limit result set to resources 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: desc

One of: asc, desc

orderby

Sort collection by object attribute.

Default: date

One of: date, relevance, id, include, title, slug, menu_order

parent

Limit result set to those of particular parent ids.

Default:

parent_exclude

Limit result set to all items except those of a particular parent id.

Default:

slug

Limit result set to posts with a specific slug.

status

Limit result set to posts assigned a specific status; can be comma-delimited list of status types.

Default: publish

One of: publish, future, draft, pending, private, trash, auto-draft, inherit, any

filter

Use WP Query arguments to modify the response; private query vars require appropriate authorization.

Top ↑

Definition Definition

GET /wp/v2/pages

Example Request Example Request

$ curl http://demo.wp-api.org/wp-json/wp/v2/pages

Top ↑

Retrieve a Page Retrieve a Page

Top ↑

Arguments Arguments

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 ↑

Definition Definition

GET /wp/v2/pages/<id>

Example Request Example Request

$ curl http://demo.wp-api.org/wp-json/wp/v2/pages/<id>

Top ↑

Create a Page Create a Page

Top ↑

Arguments Arguments

date

The date the object was published, in the site’s timezone.

date_gmt

The date the object was published, as GMT.

slug

An alphanumeric identifier for the object unique to its type.

status

A named status for the object.

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

parent

The id for the parent of the object.

title

The title for the object.

content

The content for the object.

author

The id for the author of the object.

excerpt

The excerpt for the object.

featured_media

The id of the featured media for the object.

comment_status

Whether or not comments are open on the object.

One of: open, closed

ping_status

Whether or not the object can be pinged.

One of: open, closed

menu_order

The order of the object in relation to other object of its type.

meta

Meta fields.

template

The theme file to use to display the object.

One of:

Top ↑

Definition Definition

POST /wp/v2/pages

Top ↑

Update a Page Update a Page

Top ↑

Arguments Arguments

date

The date the object was published, in the site’s timezone.

date_gmt

The date the object was published, as GMT.

slug

An alphanumeric identifier for the object unique to its type.

status

A named status for the object.

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

parent

The id for the parent of the object.

title

The title for the object.

content

The content for the object.

author

The id for the author of the object.

excerpt

The excerpt for the object.

featured_media

The id of the featured media for the object.

comment_status

Whether or not comments are open on the object.

One of: open, closed

ping_status

Whether or not the object can be pinged.

One of: open, closed

menu_order

The order of the object in relation to other object of its type.

meta

Meta fields.

template

The theme file to use to display the object.

One of:

Top ↑

Definition Definition

POST /wp/v2/pages/<id>

Example Request Example Request

Top ↑

Delete a Page Delete a Page

Top ↑

Arguments Arguments

force

Whether to bypass trash and force deletion.

Top ↑

Definition Definition

DELETE /wp/v2/pages/<id>

Example Request Example Request

$ curl -X DELETE http://demo.wp-api.org/wp-json/wp/v2/pages/<id>