Skip to main content
GET
Get a collection

Authorizations

Authorization
string
header
required

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

Path Parameters

handle
string
required

The collection's URL handle, or its UUID.

Response

The collection

A published product collection. Private configuration (how membership is decided — hand-picked vs. rule-driven — and any rules) is never exposed; the API describes only what a storefront renders.

id
string<uuid>
required
handle
string
required

URL handle, unique per workspace.

Example:

"summer-sale"

name
string
required
description
string
image_url
string

Full-size cover image (absent when unset).

image_thumbnail
string

500×500 cover thumbnail.

seo_title
string
seo_description
string
sort_order
enum<string>

How products are ordered within the collection.

Available options:
MANUAL,
TITLE_ASC,
TITLE_DESC,
CREATED_ASC,
CREATED_DESC,
STOCK_DESC
product_count
integer

Count of storefront-available products currently in the collection.

created_at
string<date-time>
updated_at
string<date-time>