Skip to main content
GET
List customers with analytics

Query Parameters

limit
integer
default:20

Max items to return

Required range: 1 <= x <= 100
Example:

20

offset
integer | null
default:0

Items to skip

Required range: x >= 0
Example:

0

Search query

Maximum string length: 200
Example:

"john"

sortBy
enum<string>
default:created_at

Sort field

Available options:
total_spend,
total_orders,
last_order,
created_at
sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc

Response

List of customers

List customers response

customers
object[]
required
total
number
required