Skip to main content
GET
/
api
/
v1
/
businesses
/
{businessId}
/
shopify
/
customers
Error
A valid request URL is required to generate request examples
{}

Authorizations

​
Authorization
string
header
required

API key prefixed with sk-ak-. Pass as Authorization: Bearer sk-ak-...

Path Parameters

​
businessId
string<uuid>
required

The business ID

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100
​
rfmSegment
string

Filter by RFM segment (Champions, Loyal, At Risk, New, etc.)

​
sort
enum<string>
default:-totalSpent

Sort field

Available options:
totalSpent,
-totalSpent,
ordersCount,
-ordersCount,
createdAt,
-createdAt

Response

Paginated list of customers with RFM data

The response is of type object.