Get all customers with filters
Customers
Get all customers with filters
Retrieves a list of customers with optional filtering and pagination.
This endpoint allows you to search and filter customers based on various criteria.
Use Cases
- List all customers with pagination
- Search customers by name or email
- Filter customers by status
- Export customer data
Query Parameters
skip: Number of records to skip (default: 0, min: 0)take: Number of records to take (default: 10, min: 1, max: 100)status: Filter by customer status (ACTIVE, BLACKLISTED, DEACTIVATED)name: Filter by customer name (partial match, case-insensitive)email: Filter by customer email (exact match, case-insensitive)
Example Request
GET /api/v0/customers?skip=0&take=20&status=ACTIVE&name=John
Example Response
{
"data": [
{
"id": "cust_123456",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"phone_number": "+1-555-123-4567",
"customer_type": "Startup",
"status": "ACTIVE",
"created_at": "2024-03-20T10:00:00Z",
"updated_at": "2024-03-20T10:00:00Z"
}
],
"total": 100,
"skip": 0,
"take": 10
}
GET
Get all customers with filters
Authorizations
Your secret API key. Keep this secure and never expose it in client-side code.
Query Parameters
Number of records to skip for pagination
Required range:
x >= 0Example:
0
Number of records to return (max 100)
Required range:
1 <= x <= 100Example:
10
Filter customers by status Current status of the customer account. Controls access to services and features.
Available options:
ACTIVE, BLACKLISTED, DEACTIVATED, DELETED Filter customers by name (partial match, case-insensitive)
Maximum string length:
100Example:
"John"
Filter customers by email (exact match, case-insensitive)
Maximum string length:
255Example:
"john.doe@example.com"
Response
Successfully retrieved customers