List products

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

typestring

Filter by product type ('manual' or 'shopify')

categorystring

Filter by category (e.g. 'Finished Goods', 'Ingredients', 'Packaging')

include_variantsbooleandefault: False

Whether to include variant details

archivedboolean

Filter by archived status (true/false/null for all)

searchstring

Fuzzy search term (trigram-similarity matching against the entity's primary text columns). Trimmed; ignored when blank.

cursorstring

Cursor for pagination

limitinteger

Pagination limit

directionstringdefault: next

Pagination direction: 'next' or 'prev'

include_total_countbooleandefault: False

Whether to include total count (expensive - avoid if possible)

sort_bystring

Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.

descendingbooleandefault: True

Sort direction: true for descending (newest/largest first), false for ascending

Responses