Skip to main content
GET
List products

Authorizations

Authorization
string
header
required

Workspace API key. The workspace is derived from the key.

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100
sort_by
string
default:createdAt
sort_order
enum<string>
default:desc
Available options:
asc,
desc
categories
string

Filter to products that belong to all of the given categories (comma-separated ids or slugs). Each term rolls up to include the category's children, so a parent term also matches products in its child categories (e.g. men matches a product only in kaftan when kaftan is a child of men). An unrecognized term yields an empty page, never an error.

Response

A page of products

page
integer
size
integer
total
integer
total_pages
integer
has_next_page
boolean
has_previous_page
boolean
items
object[]