Dev Center
Dev Center
API Docs
API Reference
Theme Docs
Tools
Library
Blog
Changelog
My Apps
Create Account
No results found.
Storefront APIs
Customer Login SSO
GraphQL Storefront API
graphql
Management APIs
Customers
Get All Customers
get
Create Customers
post
Update Customers
put
Delete Customers
delete
Customer Addresses
Customer Attributes
Customer Attribute Values
Customer Form Field Values
Customer Consent
Customer Stored Instruments
Customer Settings
Customer Settings Channel
Customer Validate Credentials
Webhook Callbacks
Provider APIs
get

/customers

Returns a list of Customers. Optional filter parameters can be passed in.

Notes

Attribute names are not available on the customer object.

Authorization

apiKey - X-Auth-Token

Request Parameters

17 Query Parameters

Responses

200

Customer Collection Response

Schema
object
$schema: http://json-schema.org/draft-04/schema#
data
array[object]
meta
object

Data about the response, including pagination and collection totals.

Send a Test Request

SettingsHeaders [1]Query [17]Code Generation
Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
store_hash
X-Auth-Token