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

Query Parameters

page
integer
limit
integer

Email + name full-text-ish search

expand
string

Comma-separated associations to expand (e.g., addresses, store_credits). Use dot notation for nested expand (max 4 levels).

fields
string

Comma-separated list of fields to include (e.g., email,first_name,last_name). id is always included.

Response

200 - application/json

customers found