Skip to main content
GET
Error

Query Parameters

page
integer
default:1

Current page of the collection.

per_page
integer
default:10

Maximum number of items to return per page.

Limit results to those matching a search string.

exclude
integer[]

Ensure result set excludes specific IDs.

include
integer[]

Limit result set to specific IDs.

order
enum<string>
default:asc

Sort order.

Available options:
asc,
desc
orderby
enum<string>
default:name

Sort categories by field.

Available options:
id,
include,
name,
slug,
term_group,
description,
count
parent
integer

Limit results to categories with a specific parent.

hide_empty
boolean
default:false

Whether to hide categories with no products.

slug
string[]

Limit result set to categories with specific slug(s).

Response

Product categories retrieved successfully.

id
integer

Category ID

name
string

Category name

slug
string

Category slug

rest_url
string

REST URL for this category