Skip to main content
GET
Get lookbook details by slug

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.

Headers

x-visitor-id
string

Header form of visitor_id. Takes precedence over the query parameter when both are sent.

x-session-id
string

Header form of session_id. Takes precedence over the query parameter when both are sent.

Path Parameters

slug
string
required

Query Parameters

fields
string

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

Allowed Fields:

  • id, title, slug, description, featured_image
  • collection_id, published_at, created_at, images
visitor_id
string

Identifies the shopper viewing the lookbook, so the view is attributed to them in your content analytics. Send the same value you use for other storefront analytics calls. When omitted, the view is attributed to a coarse fallback derived from the request, so repeat views by one shopper may not group together.

The x-visitor-id header carries the same value and takes precedence.

session_id
string

Groups this view into a browsing session. When omitted, a session is derived from the visitor identity.

The x-session-id header carries the same value and takes precedence.

Response

Success

id
string<uuid>
title
string
slug
string
description
string
status
enum<string>

Publication status. Only published lookbooks are returned by the public API.

Available options:
published,
draft
collection_id
string | null

The product collection this lookbook is backed by, or null if it is standalone.

published_at
string<date-time>
created_at
string<date-time>
images
object[]

Ordered gallery images. Each image may carry shoppable hotspots.