Ingresar
DocumentaciónGuíasReferenciaWebhooksRecursos
Contactos

Listar contactos

Usalo para buscar y segmentar contactos desde tu sistema: filtrá por nombre, teléfono, email, etiquetas, campos personalizados, país, fecha de alta o lead score. Es la base para sincronizar o exportar tu CRM.

GET
/contacts

Permiso requerido: conversations:read

Autorización

http
headerAuthorizationBearer <clave>

Parámetros de consulta

name?string
email?string
phone?string
whatsapp_id?string
country_codes[]?array<string>
status?string
image?string
created_at?string
Formatodate-time
created_from?string
Formatodate-time
created_to?string
Formatodate-time
tag_ids[]?array<integer>
tag_mode?string
Valor en"all""any""exclude"
custom_field_ids[]?array<integer>
custom_field_mode?string
Valor en"all""any""exclude"
custom_field_value?string
custom_field_date_from?string
Formatodate
custom_field_date_to?string
Formatodate
custom_field_numeric_operator?string
Valor en"lt""eq""gt"
custom_field_numeric_value?number
only_with_phone?string
only_with_mac?string
scopeToAdvisor?string
lead_score_categories[]?array<>
Valor en"insufficient_data""hot""warm""cold"
lead_score_min?integer
Rango0 <= value <= 100
lead_score_max?integer
Rango0 <= value <= 100
lead_score_disqualified?|
Valor en"include""exclude""only"null
tag_filters?array<>
custom_field_filters?array<>
perPage?integer
Rango1 <= value <= 100
Por defecto25
orderBy?string
Valor en"id""name""email""phone""status""favorite""unread_messages""created_at""updated_at"
orderByMethod?string
Valor en"asc""desc"

Cuerpo de la respuesta

OK

application/json
  1. response
data*array<>
links*
meta*
curl -X GET "https://example.com/contacts"
{  "data": [    {      "id": 0,      "name": "string",      "email": "string",      "phone": "string",      "whatsapp_id": "string",      "whatsapp_username": "string",      "has_phone": true,      "country_code": "string",      "status": 0,      "image": "string",      "notes": "string",      "custom_fields": [        {          "id": 0,          "name": "string",          "description": "string",          "type": "string",          "value": "string",          "created_at": "string",          "updated_at": "string",          "contact_count": "string"        }      ],      "created_at": "2019-08-24T14:15:22Z",      "active_conversation": 0,      "favorite": 0,      "unread_messages": 0,      "manually_unread": true,      "last_message": {        "text": "string",        "file": "string",        "date": "string",        "type": "string",        "own": "string",        "deleted_at": "string",        "deleted_scope": "string"      },      "device_id": 0,      "adviser_id": 0,      "paused_at": "string",      "mac_date": "string",      "is_mac_inactive": true,      "ai_assistant_name": "string",      "stage_since": "string",      "is_stagnant": true,      "lead_score": {        "score": 0,        "signals_count": 0,        "category": "string",        "confidence": "string",        "disqualified": true,        "disqualified_at": "string",        "updated_at": "string"      },      "name_mismatch": [        null      ]    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 0,    "from": 0,    "last_page": 0,    "links": [      {        "url": "string",        "label": "string",        "active": true      }    ],    "path": "string",    "per_page": 0,    "to": 0,    "total": 0  }}

Contactos

Un contacto es la persona con la que tu negocio conversa por WhatsApp, identificada por phone o whatsapp_id.

Crear un contacto POST

Sirve para dar de alta un contacto nuevo (teléfono o WhatsApp ID, nombre, email) cuando sabés que no existe. Si no estás seguro, usá la operación de crear o actualizar.