Skip to main content
GET
Get a category

Authorizations

Authorization
string
header
required

Workspace API key. The workspace is derived from the key.

Path Parameters

category
string
required

The category's slug, or its UUID.

Response

The category

A product category. The taxonomy is one level deep: parent is null for a top-level category and set on a child, and a child never has children of its own.

id
string<uuid>
required
name
string
required
Example:

"Kaftan"

slug
string
required

URL slug, unique per workspace. Address the category by this or by its id.

Example:

"kaftan"

position
integer<int64>
required

Sort position within the taxonomy (ascending; ties broken by name).

product_count
integer
required

Distinct products in this category and its children — a product in both a parent and its child counts once. Counts raw membership, so it includes products a storefront wouldn't show (drafts, hidden).

parent
string<uuid> | null

Parent category id. Null for a top-level category.

parent_slug
string

Parent category slug. Absent for a top-level category.

Example:

"men"

createdAt
string<date-time>
updatedAt
string<date-time>