Skip to main content
GET
Spree Admin SDK

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Bearer token for admin authentication

Path Parameters

id
string
required

Collection ID

Query Parameters

expand
string

Comma-separated associations to expand (e.g., rules, custom_fields, translations).

Response

collection found

id
string
required
name
string
required
position
number
required
sort_order
enum<string>
required
Available options:
manual,
best_selling,
price asc,
price desc,
available_on desc,
available_on asc,
name asc,
name desc
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
automatic
boolean
required
rules_match_policy
enum<string>
required
Available options:
all,
any
metadata
object
required
created_at
string
required
updated_at
string
required
custom_fields
object[]
translations
object
rules
object[]