v1

latestOpenAPI 3.0.3Proprietary2026-08-0610636149.4 KB

Contacts

Buscar contactos

Búsqueda de contactos con filtros avanzados.

get/v1/contacts

Query parameters

searchstring

Búsqueda fuzzy en nombre, email y teléfono

emailstring

Filtrar por email (búsqueda parcial)

namestring

Filtrar por nombre (búsqueda parcial)

phonestring

Filtrar por teléfono (búsqueda parcial)

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

Filtrar por estado del contacto

subStatusstring

Filtrar por sub-estado

websiteIdstring

Filtrar por canal (IDs separados por coma)

assignedTostring

Filtrar por agente asignado (IDs separados por coma, o UNASSIGNED)

entryMethodstring

Filtrar por método de entrada (WEB, WHATSAPP, FACEBOOK, etc.)

conversationTagsstring

Filtrar por tags de conversación (separados por coma)

ratingstring

Filtrar por calificación (valores separados por coma)

dateFromstring date-time

Contactos creados después de esta fecha (ISO 8601)

dateTostring date-time

Contactos creados antes de esta fecha (ISO 8601)

lastUpdateDateFromstring date-time

Contactos actualizados después de esta fecha (ISO 8601)

lastUpdateDateTostring date-time

Contactos actualizados antes de esta fecha (ISO 8601)

orderBystring

Campo para ordenar (ej: creationDate, name, email)

order'asc' | 'desc'

Dirección de ordenamiento

pageinteger

Número de página

limitinteger

Resultados por página

Response

Resultados de la búsqueda

Example response

{
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 42,
    "totalPages": 3,
    "hasNext": true
  },
  "data": [
    {
      "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"
    }
  ]
}