Skip to main content
GET
List reviews for a product

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

product_id
string<uuid>
required

Filter reviews for this product. Required.

store_id
string<uuid>

Marketplace operator key only — and required for operator keys. The merchant that owns the product whose reviews you are reading. Ignored when using a single-store key.

variant_id
string<uuid>

Further filter to reviews that mention a specific variant.

status
enum<string>
default:approved

Review status filter. Publishable keys always see only approved regardless of this parameter. Secret keys can pass pending, rejected, or all.

Available options:
approved,
pending,
rejected,
all
rating
integer

Filter to reviews with this exact star rating.

Required range: 1 <= x <= 5
sort
enum<string>
default:newest

Sort order: newest/oldest by submission date; highest/lowest by rating.

Available options:
newest,
oldest,
highest,
lowest
limit
integer
default:20

Number of reviews to return per page.

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

Pagination cursor from the previous response's pagination.next_cursor. Omit for the first page.

Response

Reviews retrieved successfully

reviews
object[]
required
pagination
object
required
summary
object
required