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

Path Parameters

id
string
required

Customer group prefixed ID

Query Parameters

expand
string

Comma-separated associations to embed. Supported: customers.

fields
string

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

Response

customer group with embedded customers

id
string
required
name
string
required
description
string | null
required
customers_count
number
required
created_at
string
required
updated_at
string
required
customers
object[]