Skip to main content
GET
List the shopper's disputes

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-auth-token
string

Customer session token from POST /v1/auth/login or POST /v1/auth/verify-otp. Provide this or x-external-auth.

x-external-auth
string

Bring-your-own-auth assertion identifying the customer. Provide this or x-auth-token.

Query Parameters

status
enum<string>

Filter to disputes in this status.

Available options:
open,
under_review,
awaiting_buyer,
awaiting_seller,
resolved,
rejected,
cancelled
limit
integer
default:20

Maximum number of disputes to return.

Required range: 1 <= x <= 100
store_id
string<uuid>

Marketplace operator key only — and required for operator keys. On a marketplace storefront (which holds the operator key, not a single merchant's key), pass the merchant the shopper is acting at, so the call resolves their disputes at that merchant. Ignored for single-store keys.

Response

Disputes retrieved successfully

data
object[]
required