Back to Resources
customers
read:customersbizily://customersSearch and list customers in the CRM. Supports filtering by status, source, tags, and intent score. Returns customer contact info, booking stats, and interaction history.
Parameters
Input Parameters
| Property | Type | Description |
|---|---|---|
query | string | Search query (searches name, email, phone) |
status | "lead" | "customer" | "archived" | Filter by customer status |
source | string | Filter by acquisition source (instagram, facebook, whatsapp, sms, email, web, direct) |
intentScore | "high" | "medium" | "low" | Filter by lead intent score |
tags | string[] | Filter by tags (all must match) |
hasEmail | boolean | Only customers with email |
hasPhone | boolean | Only customers with phone |
page | number(default: 1) | Page number for pagination |
limit | number(default: 20) | Results per page (1-100) |
sortBy | string(default: lastInteractionAt) | Sort field (name, createdAt, lastInteractionAt, totalBookings, totalSpent) |
sortDirection | "asc" | "desc"(default: desc) | Sort direction |
Response
Response Schema
| Property | Type | Description |
|---|---|---|
customersrequired | Customer[] | Array of customer objects |
paginationrequired | Pagination | Pagination metadata |
Example
Requestjson
{
"type": "resource",
"name": "customers",
"params": {
"status": "customer",
"limit": 10,
"sortBy": "totalSpent",
"sortDirection": "desc"
}
}Responsejson
{
"success": true,
"data": {
"customers": [
{
"id": "uuid-1234",
"name": "Jane Smith",
"email": "jane@example.com",
"phone": "+1234567890",
"status": "customer",
"totalBookings": 12,
"totalSpent": 1250,
"lastInteractionAt": "2024-01-15T10:30:00Z"
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 45,
"totalPages": 5,
"hasNext": true,
"hasPrev": false
}
}
}cURL Example
curl -X POST https://app.bizily.io/api/mcp \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{\n "type": "resource",\n "name": "customers",\n "params": {\n "status": "customer",\n "limit": 10,\n "sortBy": "totalSpent",\n "sortDirection": "desc"\n }\n}'