Search customers
Customers by name, email, tag or company, with their open conversation count.
GET https://cotlet.dev/api/v1/kustomer/customers/search
read
Searches customer profiles by name, email address, phone, tag or company and returns the matches with contact details. Use customer_id with get_customer for the full profile or with search_conversations for their conversations. Pass next_cursor back as cursor for the next page.
Parameters
| Name | Type | Description |
|---|---|---|
| query string required | string | Name, email, phone or company name. |
| tag string | string | Only customers with this tag. |
| limit integer | integer | Results per page. Default: 25. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl "https://cotlet.dev/api/v1/kustomer/customers/search?query=query" \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("kustomer", "search_customers", {"query":"query"})const result = await cotlet.call('kustomer', 'search_customers', {"query":"query"});cotlet call kustomer search_customers --data '{"query":"query"}'Example response
{
"customers": [
{
"customer_id": "6712a0b4a1b2c3d4e5f60101",
"name": "Dana Whitfield",
"email": "dana@example.com",
"company": "Northwind Studio",
"tags": [
"vip"
]
}
],
"next_cursor": null
}