Skip to main content
GET
List promotions

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

status
enum<string>
Available options:
active,
inactive,
scheduled,
expired
cart_total
string

Filter promotions by minimum cart total requirement (numeric string)

limit
integer
default:50
Required range: 1 <= x <= 200
cursor
string

Cursor for pagination (base64-encoded)

fields
string

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

Allowed Fields:

  • id, name, type, display_type, value, min_purchase
  • start_date, end_date, status, conditions, image, image_mobile
  • bundle_products, bogo_required_products, bogo_free_products, free_products
  • has_time_restrictions, start_time, end_time, time_zone, apply_to_days
  • created_at, updated_at

Response

Success

promotions
object[]
pagination
object