Get promotion details

GET /v1/promotions/{id}

Get promotion details

cURL

curl --request GET \
  --url https://api.tybritelabs.com/v1/promotions/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "display_type": "<string>",
  "description": "<string>",
  "image": "<string>",
  "discount_value": 123,
  "min_purchase": 123,
  "max_discount": 123,
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "usage_limit": 123,
  "usage_per_customer": 123,
  "bundle_products": [
    {}
  ],
  "bogo_required_products": [
    {}
  ],
  "bogo_free_products": [
    {}
  ],
  "free_products": [
    {}
  ],
  "applicable_categories": [
    "<string>"
  ],
  "applicable_products": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

API Key Authentication

Use your API key in the Authorization header:

Authorization: Bearer tybrite_sk_live_YOUR_KEY

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

fields · string

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

Allowed Fields:

• id, name, type, display_type, description
• discount_value, discount_type, min_purchase, max_discount
• start_date, end_date, status
• usage_limit, usage_per_customer
• bundle_products, bogo_required_products, bogo_free_products, free_products
• applicable_categories, applicable_products
• created_at, updated_at

Response

200

application/json

Success

id · string<uuid>

name · string

type · enum<string>

Available options: fixed, discount, bundle, bogo

display_type · string

description · string

image · string<uri> | null

URL of the promotion image

discount_value · number

discount_type · enum<string>

Available options: percentage, fixed

min_purchase · number

max_discount · number

start_date · string<date-time>

end_date · string<date-time>

status · enum<string>

Available options: active, inactive, scheduled, expired

usage_limit · integer

usage_per_customer · integer

bundle_products · object[]

bogo_required_products · object[]

bogo_free_products · object[]

free_products · object[]

applicable_categories · string[]

applicable_products · string[]

created_at · string<date-time>

updated_at · string<date-time>