Skip to main content
GET
List customers

Authorizations

Authorization
string
header
required

Access token issued by auth.signIn. Expires; refresh it with auth.refresh.

Query Parameters

status
default:all
Available options:
active,
inactive,
churned
country
string
default:""
sort
enum<string>
default:lastActivityDate
Available options:
name,
totalAmountSpent,
totalTransactions,
lastActivityDate
direction
enum<string>
default:desc
Available options:
asc,
desc
page
integer
default:1
Required range: 1 <= x <= 9007199254740991
limit
integer
default:50
Required range: 1 <= x <= 200

Response

OK

items
object[]
required
total
integer
required
Required range: 0 <= x <= 9007199254740991
page
integer
required
Required range: 1 <= x <= 9007199254740991
limit
integer
required
Required range: 1 <= x <= 9007199254740991
Last modified on October 6, 2026