Skip to main content
GET
/
products
/
categories
[
  {
    "id": 15,
    "name": "Electronics",
    "slug": "electronics",
    "description": "Electronic devices and accessories for modern living",
    "display": "default",
    "image": {
      "id": 234,
      "date_created": "2024-01-10T08:00:00",
      "date_modified": "2024-01-10T08:00:00",
      "src": "https://example-store.com/wp-content/uploads/2024/01/electronics-category.jpg",
      "name": "electronics-category",
      "alt": "Electronics Category"
    },
    "menu_order": 0,
    "count": 156
  },
  {
    "id": 23,
    "name": "Clothing",
    "slug": "clothing",
    "description": "Fashion and apparel for all occasions",
    "display": "default",
    "image": {
      "id": 345,
      "date_created": "2024-01-12T09:30:00",
      "date_modified": "2024-01-12T09:30:00",
      "src": "https://example-store.com/wp-content/uploads/2024/01/clothing-category.jpg",
      "name": "clothing-category",
      "alt": "Clothing Category"
    },
    "menu_order": 1,
    "count": 284
  },
  {
    "id": 28,
    "name": "T-Shirts",
    "slug": "t-shirts",
    "description": "Comfortable t-shirts in various styles",
    "display": "default",
    "image": null,
    "menu_order": 0,
    "count": 89
  }
]

Query Parameters

​
page
integer
default:1

Current page of the collection.

​
per_page
integer
default:10

Maximum number of items to return per page.

​
search
string

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

⌘I