List customers

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: customers } = await client.customers.list({
  search: 'jane',
  sort: '-created_at',
  limit: 25,
})

{
  "data": [
    {
      "id": "cust_UkLWZg9DAJ",
      "email": "jane@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "phone": null,
      "accepts_email_marketing": false,
      "email_marketing_consent_updated_at": "2026-01-15T12:00:00Z",
      "full_name": "Jane Doe",
      "available_store_credit_total": "0.00",
      "failed_attempts": 0,
      "metadata": {},
      "email_marketing_consent_source": "unknown",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "anonymized_at": null,
      "anonymized": false,
      "tags": [],
      "internal_note": null,
      "internal_note_html": null,
      "default_billing_address_id": null,
      "default_shipping_address_id": null,
      "orders_count": 0,
      "total_spent": "0.00",
      "last_order_completed_at": null,
      "customer_group_ids": []
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

GET

api

admin

customers

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: customers } = await client.customers.list({
  search: 'jane',
  sort: '-created_at',
  limit: 25,
})

{
  "data": [
    {
      "id": "cust_UkLWZg9DAJ",
      "email": "jane@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "phone": null,
      "accepts_email_marketing": false,
      "email_marketing_consent_updated_at": "2026-01-15T12:00:00Z",
      "full_name": "Jane Doe",
      "available_store_credit_total": "0.00",
      "failed_attempts": 0,
      "metadata": {},
      "email_marketing_consent_source": "unknown",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "anonymized_at": null,
      "anonymized": false,
      "tags": [],
      "internal_note": null,
      "internal_note_html": null,
      "default_billing_address_id": null,
      "default_shipping_address_id": null,
      "orders_count": 0,
      "total_spent": "0.00",
      "last_order_completed_at": null,
      "customer_group_ids": []
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[email_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`accepts_email_marketing`	True or false	`eq` `not_eq` `in` `not_in` `true` `false` `null`
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`email`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`first_name`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`last_name`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`phone`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

Filters through associations

Prefix an associated record’s attribute with the association, as in q[addresses_id_eq]. The same predicates apply.

Prefix	Attributes
`addresses_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`bill_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`customer_groups_`	`created_at`, `id`, `name`, `updated_at`
`orders_`	`channel_id`, `completed_at`, `considered_risky`, `coupon_code`, `created_at`, `currency`, `customer_id`, `delivery_total`, `email`, `fulfillment_status`, `id`, `item_total`, `locale`, `market_id`, `number`, `order_group_id`, `payment_status`, `po_number`, `seller_id`, `status`, `total`, `total_quantity`, `updated_at`
`orders_bill_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`orders_channel_`	`active`, `code`, `created_at`, `default`, `id`, `name`, `store_id`, `updated_at`
`orders_fulfillments_`	`created_at`, `id`, `number`, `updated_at`
`orders_line_items_`	`additional_tax_total`, `adjustment_total`, `cost_price`, `created_at`, `discount_total`, `id`, `included_tax_total`, `non_taxable_adjustment_total`, `order_id`, `pre_tax_amount`, `price`, `quantity`, `tax_category_id`, `taxable_adjustment_total`, `updated_at`, `variant_id`
`orders_order_group_`	`created_at`, `currency`, `email`, `id`, `number`, `updated_at`
`orders_promotions_`	`code`, `created_at`, `expires_at`, `id`, `kind`, `name`, `path`, `promotion_category_id`, `starts_at`, `updated_at`
`orders_seller_`	`contact_email`, `created_at`, `id`, `name`, `status`, `updated_at`
`orders_ship_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`orders_shipments_`	`created_at`, `id`, `number`, `updated_at`
`orders_store_`	`created_at`, `id`, `name`, `updated_at`
`orders_tags_`	`created_at`, `id`, `name`, `updated_at`
`ship_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`spree_roles_`	`created_at`, `id`, `name`, `updated_at`
`tags_`	`created_at`, `id`, `name`, `updated_at`

Sort by: accepts_email_marketing, created_at, email, first_name, id, last_name, phone, updated_at. Prefix a field with - to sort descending.

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

q[search]

string

Matches email, first name, last name or full name (partial, case-insensitive).

q[anonymized]

boolean

Set to true to apply anonymized.

q[with_min_total_spent]

number

Applies with_min_total_spent to the given value.

q[with_standing_for_company][]

string[]

Applies with_standing_for_company to the given value.

page

integer

limit

integer

object

Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.

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

⌘I

API basics

Endpoints

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters