Skip to Content
FluxStore is currently invite-only. Some sections of this documentation are still being written and expanded.
APIManagement APICustomersList customers
GET/api/v1/customers

List customers in the store. Paginated and sortable. Read-only.

Personally identifiable information is not exposed through the Store Management API.

Requires the Customers:View permission.

Query parameters

searchstring
Filter by player username (case-insensitive contains match).
sortBystring
Sort field. Defaults to lastPurchaseAt.
Values:
totalSpentlastPurchaseAtcreatedAt
sortDescboolean
Sort descending. Defaults to true.
skipinteger
Results to skip. Defaults to 0.
takeinteger
Page size, max 100. Defaults to 20.

Headers

X-Api-Keystringrequired
Your API key.