Skip to main content
GET
/
v2
/
customers
List customers with pagination and filtering (v2)
curl --request GET \
  --url http://localhost:3156/v2/customers
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phoneNumber": "+1234567890",
      "active": true,
      "createdAt": "2025-01-15T10:00:00.000Z",
      "updatedAt": "2025-01-15T10:00:00.000Z"
    }
  ],
  "pagination": {
    "total": 150,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  }
}

Query Parameters

​
limit
integer
default:20

Number of customers to return per page (max 100)

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of customers to skip

Required range: x >= 0
​
email
string<email>

Filter by customer email address

​
phoneNumber
string

Filter by customer phone number

​
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