Ir al contenido
Documentación de Connecto
connecto.lat
API para desarrolladoresReferencia

Consulta de contactos

Busca contactos por uno o varios campos (por ejemplo la cédula, el correo o un campo que tú creaste) y devuelve todos sus datos y las redes o canales asociados.

Permisos#

PermisoPara qué sirveTipo
contactos:consultarConsultar contactos y sus redeslectura

Endpoints#

POST /contactos/consultar#

Devuelve los contactos que cumplen TODOS los filtros enviados (o alguno, con «coincidencia»: «alguno»).

Permiso: contactos:consultar · lectura

Cuerpo (JSON)#

CampoDescripción
filtrosobjeto {campo: valor}. El valor puede ser un texto, un número, una lista de valores (basta con que coincida uno) o {"operador": "...", "valor": "..."}.
coincidencia«todos» (por defecto: se cumplen todos los filtros) o «alguno».
paginanúmero de página (1 por defecto)
limiteresultados por página, de 1 a 100 (25 por defecto)
Ejemplo de cuerpo
{
  "filtros": {
    "numero_documento": "1020304050",
    "estado": "ACTIVO"
  },
  "coincidencia": "todos"
}
Ejemplo en curl
curl -X POST "https://TU_SUBDOMINIO.connecto.lat/api/v1/contactos/consultar" \
  -H "Authorization: Bearer cnx_TU_LLAVE" \
  -H "Content-Type: application/json" \
  -d '{"filtros":{"numero_documento":"1020304050","estado":"ACTIVO"},"coincidencia":"todos"}'
Ejemplo en javascript
const respuesta = await fetch("https://TU_SUBDOMINIO.connecto.lat/api/v1/contactos/consultar", {
  method: "POST",
  headers: { "Authorization": "Bearer " + process.env.CONNECTO_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "filtros": {
        "numero_documento": "1020304050",
        "estado": "ACTIVO"
    },
    "coincidencia": "todos"
})
});
const datos = await respuesta.json();
Ejemplo en php
$ch = curl_init("https://TU_SUBDOMINIO.connecto.lat/api/v1/contactos/consultar");
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("CONNECTO_API_KEY"), "Content-Type: application/json"],
  CURLOPT_POSTFIELDS => json_encode(array (
  'filtros' => 
  array (
    'numero_documento' => '1020304050',
    'estado' => 'ACTIVO',
  ),
  'coincidencia' => 'todos',
)),
]);
$datos = json_decode(curl_exec($ch), true);

GET /contactos/consultar#

Lo mismo que el POST, con los filtros en la dirección: ?filtro[campo]=valor&filtro[otro_campo]=valor. Para varios valores de un campo: ?filtro[estado][]=ACTIVO&filtro[estado][]=INACTIVO.

Permiso: contactos:consultar · lectura

Parámetros de la consulta#

ParámetroDescripción
filtro[campo]un filtro por cada campo a consultar
coincidenciatodos | alguno
paginanúmero de página
limitede 1 a 100
Ejemplo en curl
curl "https://TU_SUBDOMINIO.connecto.lat/api/v1/contactos/consultar?filtro[numero_documento]=1020304050&filtro[estado]=ACTIVO" \
  -H "Authorization: Bearer cnx_TU_LLAVE"
Ejemplo en javascript
const respuesta = await fetch("https://TU_SUBDOMINIO.connecto.lat/api/v1/contactos/consultar?filtro[numero_documento]=1020304050&filtro[estado]=ACTIVO", {
  method: "GET",
  headers: { "Authorization": "Bearer " + process.env.CONNECTO_API_KEY }
});
const datos = await respuesta.json();
Ejemplo en php
$ch = curl_init("https://TU_SUBDOMINIO.connecto.lat/api/v1/contactos/consultar?filtro[numero_documento]=1020304050&filtro[estado]=ACTIVO");
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("CONNECTO_API_KEY")],
]);
$datos = json_decode(curl_exec($ch), true);

GET /contactos/campos#

Lista los campos por los que se puede consultar (incluidos los que se crearon a mano), su tipo, los operadores que admiten y sus valores válidos.

Permiso: contactos:consultar · lectura

Ejemplo en curl
curl "https://TU_SUBDOMINIO.connecto.lat/api/v1/contactos/campos" \
  -H "Authorization: Bearer cnx_TU_LLAVE"
Ejemplo en javascript
const respuesta = await fetch("https://TU_SUBDOMINIO.connecto.lat/api/v1/contactos/campos", {
  method: "GET",
  headers: { "Authorization": "Bearer " + process.env.CONNECTO_API_KEY }
});
const datos = await respuesta.json();
Ejemplo en php
$ch = curl_init("https://TU_SUBDOMINIO.connecto.lat/api/v1/contactos/campos");
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("CONNECTO_API_KEY")],
]);
$datos = json_decode(curl_exec($ch), true);

Respuesta#

Cada contacto trae sus datos básicos, el tipo de contacto, el propietario, los campos opcionales activos (documento, nacionalidad, departamento, ciudad…), los campos personalizados y «redes»: una entrada por canal (WhatsApp, Messenger, Instagram, Telegram…) con las cuentas del contacto y los canales conectados por los que ha conversado.

Operadores de filtro#

OperadorSignificado
igualEs igual a (por defecto)
contieneContiene el texto
empieza_conEmpieza con
desdeMayor o igual (números y fechas)
hastaMenor o igual (números y fechas)
vacioNo tiene valor
no_vacioTiene algún valor
¿Te fue útil esta página?
Última actualización: 14/11/2026