Skip to main content
GET
Get subcategory by ID

Authorizations

​
Authorization
string
header
required

API Key Authentication

Use your API key in the Authorization header:

Key Types:

Secret Keys (Server-Side Only):

  • Format: tybrite_sk_live_* (production) or tybrite_sk_test_* (sandbox)
  • Full read/write access to all endpoints
  • ⚠️ NEVER expose in client-side code or public repositories
  • Required for: write operations, authentication, payment verification, AI recommendations

Publishable Keys (Client-Safe):

  • Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
  • Read-only access (GET requests only, plus POST semantic search)
  • ✅ Safe for client-side JavaScript, mobile apps, and public code
  • Allowed for: browsing products, search, CMS content, pricing queries

Endpoint-Specific Requirements:

  • Authentication endpoints (/v1/auth/*): Secret key required
  • Payment verification (POST /v1/payments/verify): Secret key required
  • AI Recommendations (POST /v1/recommendations): Secret key required
  • Semantic Search (POST /v1/search): Both key types allowed (read-only operation)
  • All write operations: Secret key required
  • All read operations: Both key types allowed

Using a publishable key for restricted operations returns 403 Forbidden.

Path Parameters

​
id
string<uuid>
required

Query Parameters

​
include
string

Comma-separated list of related data to nest on the response. Supported values: children (the subcategory's direct, one-level-down child subcategories, as a children array) and ancestors (the breadcrumb chain as an ancestors array ordered root-first). The trail begins with the owning category and continues down to the immediate parent, so a top-level subcategory returns a single entry: its category. Each entry carries a type of category or subcategory, because the two are different resources — a category is addressed on /v1/categories and a subcategory on /v1/subcategories — and a client linking a crumb needs to know which it holds. Combine them, e.g. include=ancestors,children. Omit for a flat subcategory object.

Example:

"ancestors,children"

​
fields
string

Comma-separated list of fields to include in the response.

Response

Success

​
id
string<uuid>
​
category_id
string<uuid>
​
parent_id
string<uuid> | null

ID of the parent subcategory, or null for a top-level subcategory directly under its category. Subcategories can be nested to arbitrary depth (e.g. Shoes → Men's → Sneakers).

​
name
string
Example:

"Keyboards"

​
slug
string

URL-safe identifier for the subcategory, stable across renames. Unique within its store, category and parent; where two names in that scope would produce the same slug, a numeric suffix is appended.

Example:

"keyboards"

​
description
string
​
image
string<uri> | null

URL of the subcategory image

​
active
boolean

Whether the subcategory is active

​
children
array

Nested child subcategories. Only included when listing subcategories with tree=true, or when fetching a single subcategory with include=children; omitted otherwise.

​
ancestors
array

Ancestor breadcrumb chain, ordered root-first. Begins with the owning category and continues down to the immediate parent, so a top-level subcategory returns one entry: its category. Each entry carries a type of category or subcategory — the two are addressed on different endpoints, so a client linking a crumb needs to know which it holds. Only included when fetching a single subcategory with include=ancestors.

​
type
enum<string>

Which level of the taxonomy this entry is. Present on entries of an ancestors chain, where both levels appear; omitted on an ordinary subcategory object.

Available options:
category,
subcategory
​
created_at
string<date-time>
​
updated_at
string<date-time>