Skip to main content
GET
List subcategories

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.

Query Parameters

store_id
string<uuid>

Marketplace operator key only. Narrow the aggregated marketplace subcategories to a single merchant. Ignored when using a single-store key.

category_id
string<uuid>

Filter subcategories by parent category ID

parent_id
string<uuid>

Return only the direct children of the given subcategory. Pass the literal value null to return only top-level subcategories (those with no parent).

root_only
boolean
default:false

When true, return only top-level subcategories (those with no parent). Useful for rendering the first level of a category's subcategory hierarchy.

tree
boolean
default:false

When true, return subcategories as a nested hierarchy: each subcategory includes a children array of its nested subcategories. The response is not paginated in this mode — the full tree is returned in one call.

Case-insensitive substring match on subcategory name

active
boolean
default:true

Filter by active status. Defaults to true (only active subcategories) when omitted.

limit
integer
default:100

Maximum number of results to return

Required range: 1 <= x <= 500
cursor
string

Cursor for pagination (base64-encoded)

fields
string

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

Response

Success

subcategories
object[]
pagination
object