v1

latestOpenAPI 3.0.3Proprietary2026-08-0610636149.4 KB

Contacts

Obtener contacto

get/v1/contacts/{contactId}

Path parameters

contactIdstring required

Response

Detalle del contacto

idstring

namestring

emailstring email

phonestring

internationalPhoneNumberstring

channelIdstring

ID del canal donde se originó el contacto

companyIdstring

ID de la empresa dueña del contacto.

conversationIdstring

ID de la conversación que originó el contacto.

status'new' | 'active' | 'client' | 'long_term'

Etapa del ciclo de vida comercial del contacto: new (recién creado), active (en gestión), client (convertido), long_term (seguimiento a largo plazo). Casing: el estado del contacto va en minúscula; no confundir con Conversation.status, que usa MAYÚSCULAS (ACTIVE, CLOSED, …). Son recursos y vocabularios distintos.

subStatusstring

Sub-estado libre del contacto (configurable por la empresa).

messagestring

Último mensaje del contacto

assignedTostring nullable

ID del agente asignado

ratinginteger

Puntuación del lead (estrellas), de 1 a 5; 0 significa sin puntuar. Vive en el contacto, no en la conversación: para puntuar una conversación traé su contacto por contactId.

entryMethodstring

Método/canal por el que ingresó el contacto (ej. WHATSAPP, WEB, FACEBOOK). Es el dato base para distinguir el canal de adquisición. Filtrable con el parámetro entryMethod en la búsqueda de contactos.

utmSourcestring

Fuente de la campaña (UTM source). Ej. google, facebook, instagram.

utmMediumstring

Medio de la campaña (UTM medium). Ej. cpc, organic, social.

utmCampaignstring

Nombre de la campaña (UTM campaign).

gclidstring

Google Click ID. Su presencia indica adquisición vía Google Ads (tráfico pago).

conversionUrlstring

URL/página donde se generó el contacto.

refererTrackingstring

Referer completo de origen del tráfico.

devicestring

Dispositivo de origen del contacto.

createdAtstring date-time

updatedAtstring date-time

Example response

{
  "id": "60a1b2c3d4e5f6a7b8c9d0e1",
  "name": "Juan Pérez",
  "email": "juan@example.com",
  "phone": "+5491155551234",
  "internationalPhoneNumber": "5491155551234",
  "rating": 4,
  "entryMethod": "WHATSAPP",
  "utmSource": "google",
  "utmMedium": "cpc",
  "utmCampaign": "black-friday-2026"
}