Skip to main content
GET
List orders

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

limit
integer
default:50

Maximum number of orders to return (1–200, default 50)

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

Opaque pagination cursor returned as pagination.next_cursor from a prior call

payment_status
enum<string>

Filter by payment status

Available options:
pending,
paid,
failed,
refunded
order_status
enum<string>

Filter by order fulfillment status

Available options:
pending,
processing,
shipped,
delivered,
cancelled
customer_id
string<uuid>

Filter to orders for a specific customer

fields
string

Comma-separated list of fields to include per order. Same allowed fields as GET /v1/orders/{id} (excluding items, which is not returned in list view).

Response

Paginated list of orders (newest first)

orders
object[]
pagination
object