Categories

Schema

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: view, embed, edit

count Number of published posts for the term.

JSON data type: integer

Read only

Context: view, edit

description HTML description of the term.

JSON data type: string

Context: view, edit

name HTML title for the term.

JSON data type: string

Context: view, embed, edit

slug An alphanumeric identifier for the term unique to its type.

JSON data type: string

Context: view, embed, edit

taxonomy Type attribution for the term.

JSON data type: string

Read only

Context: view, embed, edit

One of: category

parent The parent term ID.

JSON data type: integer

Context: view, edit

meta Meta fields.

JSON data type: object

Context: view, edit

List Categories

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

Definition

GET /wp/v2/categories

Example Request

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

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.
exclude Ensure result set excludes specific IDs.
include Limit result set to specific IDs.
order Order sort attribute ascending or descending.

Default: asc

One of: asc, desc

orderby Sort collection by term attribute.

Default: name

One of: id, include, name, slug, include_slugs, term_group, description, count

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.

Create a Category

Arguments

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.

Definition

POST /wp/v2/categories

Retrieve a Category

Definition & Example Request

GET /wp/v2/categories/<id>

Query this endpoint to retrieve a specific category record.

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

Arguments

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

Default: view

One of: view, embed, edit

Update a Category

Arguments

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.

Definition

POST /wp/v2/categories/<id>

Example Request

Delete a Category

Arguments

id Unique identifier for the term.
force Required to be true, as terms do not support trashing.

Definition

DELETE /wp/v2/categories/<id>

Example Request

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