Skip to main content
GET
Get a collection

Authorizations

x-spree-api-key
string
header
required

Publishable API key for store access

Headers

x-spree-api-key
string
required

Path Parameters

id
string
required

Collection permalink (e.g., summer-sale) or prefix ID (e.g., coll_abc123)

Query Parameters

expand
string

Expand associations (custom_fields)

fields
string

Comma-separated list of fields to include. id is always included.

Response

collection found by prefix ID

id
string
required
name
string
required
position
number
required
sort_order
string
required
meta_title
string | null
required
meta_description
string | null
required
meta_keywords
string | null
required
products_count
number
required
description
string
required
description_html
string
required
image_url
string | null
required
square_image_url
string | null
required
custom_fields
object[]