Search contacts
Find contacts by a search term, with their email, phone and number of conversations.
GET https://cotlet.dev/api/v1/chatwoot/contacts/search
read
Returns the contacts that match the term, with contact_id, name, email, phone and conversation count. Use contact_id as the contact_id of list_conversations to read their history. Chatwoot lists only resolved contacts, the ones with an identifier, an email or a phone number.
Parameters
| Name | Type | Description |
|---|---|---|
| query string required | string | Text to search for, for example an email address. |
| page integer | integer | Page number, from 1. Default: 1. |
Request
curl "https://cotlet.dev/api/v1/chatwoot/contacts/search?query=query" \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("chatwoot", "search_contacts", {"query":"query"})const result = await cotlet.call('chatwoot', 'search_contacts', {"query":"query"});cotlet call chatwoot search_contacts --data '{"query":"query"}'Example response
{
"contacts": [
{
"contact_id": 327,
"name": "Priya Nair",
"email": "priya@example.com",
"phone": null,
"conversations": 3
}
],
"page": 1,
"has_more": false
}