Skip to main content
GET
List Products

Headers

authorization
string | null
X-Organization-ID
string | null

Query Parameters

product_type
string | null

Filter by product type key

status
string | null

Filter by status

enrichment_status
string | null

Filter by enrichment status

publish_status
string | null

Filter by computed publish status: draft | live | changed

Pattern: ^(draft|live|changed)$
brand
string | null

Filter by brand name

is_published
boolean | null

Filter by published status

source
string | null

Filter by source

created_by
string | null

Filter by creator (user ID)

created_after
string | null

Filter by creation date (ISO 8601)

created_before
string | null

Filter by creation date (ISO 8601)

updated_after
string | null

Filter by update date (ISO 8601)

updated_before
string | null

Filter by update date (ISO 8601)

batch_key
string | null

Filter to products that have any record (any status) in the given catalog batch.

has_quality_findings
boolean | null

true: restrict to products with at least one advisory quality finding on their latest scoring run. Products that were never scored, or scored clean, are excluded. NOT best-effort: unlike quality_finding_count on each returned item (which silently omits the count if scoring is unavailable), this filter fails the request -- 503 if the underlying lookup errors, 400 if it matches too many products to filter precisely -- rather than silently returning unfiltered or incomplete results while appearing applied.

property_filter
string[] | null

Repeatable: key:value

keys
string[] | null

Repeatable: restrict to these exact product keys (max 1000; 400 beyond).

name_contains
string | null

Case-insensitive substring match on product name.

key_contains
string | null

Case-insensitive substring match on product key.

sort_by
string | null

Sort field. One of: brand, created_at, enrichment_score, enrichment_status, key, name, product_type, publish_status, updated_at

sort_dir
string
default:asc
Pattern: ^(asc|desc)$
limit
integer
default:50
Required range: 1 <= x <= 100
skip
integer
default:0
Required range: x >= 0

Cookies

stytch_session
string | null

Response

Successful Response

Response model for list of Products.

items
ProductResponse · object[]
required
limit
integer
required
offset
integer
required
total
integer
required