Get product collection by ID
Authorizations
API Key Authentication
Use your API key in the Authorization header:
Key Types:
Secret Keys (Server-Side Only):
- Format:
tybrite_sk_live_*(production) ortybrite_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) ortybrite_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
Product collection UUID
Response
Success
"Summer Sale"
"summer-sale"
The kind of collection. featured_collections is a manually curated set;
new_arrivals and best_selling are automatically maintained.
featured_collections, new_arrivals, best_selling, manual, automated, smart URL of the collection banner image (desktop, and the fallback used on all viewports when no mobile image is set).
Optional URL of a phone-sized collection banner. Storefronts render this on
small viewports when set and fall back to image otherwise.
Smart/automated collection rules (when collection_type is automated or smart)

