v1
latestOpenAPI 3.0.02026-07-2612645160.3 KBContact
Search contacts by phone or email
Find contacts by phone number or email address. Searches across all channels. At least one search parameter is required.
get/api/public/contacts/search
Query parameters
phonestring
Example:+56912345678
Phone number to search (partial match supported)
emailstring email
Example:john@example.com
Email address to search (partial match supported)
with_utm_eventsboolean
Example:true
Set to true to include the per-contact utm_events array (marketing attribution). Off by default — the key is omitted entirely unless requested, since it costs an extra lookup. Opt in only if you consume UTM attribution.
Headers
x-api-keystring required
API key needed to authorize the request
Response
Contacts found successfully.
Example response
[
{
"id": "df980fc8-b6db-4820-bf22-2969482d106d",
"name": "John Doe",
"phone": "+56912345678",
"email": "john@example.com",
"platform": "whatsapp",
"last_message_at": "2024-09-30T10:00:00.000Z",
"chat_status": "ATTENDED",
"created_at": "2024-01-15T10:00:00.000Z",
"updated_at": "2024-01-16T09:30:00.000Z",
"client_id": "123e4567-e89b-12d3-a456-426614174000",
"ai_customer_id": "123e4567-e89b-12d3-a456-426614174000",
"default_stage_id": "123e4567-e89b-12d3-a456-426614174000",
"is_chat_read": true,
"utm_events": [
{
"created_at": "2024-01-15T10:00:00.000Z",
"integration_type": "facebook",
"referrer_url": "https://example.com/landing"
}
]
}
]