Returns a paginated list of customers. Supports Ransack search/filters.
Required scope: read_customers (for API-key authentication).
Documentation Index
Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt
Use this file to discover all available pages before exploring further.
Secret API key for admin access
JWT token for admin user authentication
Bearer token for admin authentication
Email + name full-text-ish search
Comma-separated associations to expand (e.g., addresses, store_credits). Use dot notation for nested expand (max 4 levels).
Comma-separated list of fields to include (e.g., email,first_name,last_name). id is always included.
customers found