Skip to main content
GET
List customers with pagination and filtering (v2)

Query Parameters

limit
integer
default:20

Number of customers to return per page (max 100)

Required range: 1 <= x <= 100
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
email
string<email>

Filter by customer email address

phoneNumber
string

Filter by customer phone number

email__contains
string

Filter customers by partial email match (case-insensitive). Example: ?email__contains=example will match all emails containing 'example'.

active
enum<string>

Filter by customer active status (true/false or 1/0)

Available options:
true,
false,
1,
0

Response

Customers retrieved successfully

data
object[]
required

List of customers

pagination
object
required