Skip to main content
Browse related product families

Headers

If-None-Match
string

Strong entity tag from an earlier response.

If-Modified-Since
string

HTTP-date fallback validator. ETag takes precedence.

Query Parameters

q
string

Case-insensitive family name, slug, or reviewed brand search. Nonempty queries must retain at least one character after normalization.

Required string length: 1 - 200
brand_ids
string<uuid>[]

Comma-separated reviewed Nektir brand UUIDs; OR semantics within this filter and AND semantics with other filter groups. Unresolved products do not match.

Maximum array length: 25
category_ids
string[]

Comma-separated API category IDs; OR semantics. Selecting a parent category includes products assigned to any active descendant category.

Maximum array length: 20
Pattern: ^cat_[a-z0-9_]+$
relationship_type
enum<string>[]

Comma-separated reviewed relationships between products and their family.

Maximum array length: 4
Available options:
expression,
package_variant,
successor,
other
sort
enum<string>
default:name
Available options:
name,
-name
limit
integer
default:25
Required range: 1 <= x <= 100
cursor
string

Signed opaque keyset cursor, valid for 15 minutes and only with the original resource endpoint, query, and sort. Reuse on another endpoint or with changed filters returns CURSOR_QUERY_MISMATCH. Follow links.next unchanged.

Maximum string length: 2048

Response

Deterministically paginated product-family summaries.

data
object[]
required
meta
object
required