API de Contactos

Permite listar, buscar y paginar contactos almacenados en tu espacio de trabajo.


Obtener Lista de Contactos

  • Método: GET
  • Ruta: /api/v1/integrations/:integrationKey/contacts
  • Autenticación: Bearer sf_int_...

Parámetros de Consulta (Query Params)

Parámetro Tipo Requerido Por defecto Descripción
page number No 1 Número de página a consultar.
limit number No 20 Cantidad de registros por página (máximo 100).
search string No "" Búsqueda por coincidencia en nombre (displayName) o número de teléfono.

Ejemplo de Petición en cURL

curl -X GET "https://api.omniflou.com/api/v1/integrations/agendaconmigo/contacts?page=1&limit=10&search=Carlos" \
  -H "Authorization: Bearer sf_int_agendaconmigo_your_token_here"

Ejemplo en Node.js (Fetch)

const response = await fetch('https://api.omniflou.com/api/v1/integrations/agendaconmigo/contacts?search=Carlos', {
  headers: {
    'Authorization': 'Bearer sf_int_agendaconmigo_your_token_here'
  }
});
const data = await response.json();
console.log(data.docs);

Ejemplo de Respuesta Exitosa (200 OK)

{
  "docs": [
    {
      "_id": "6a4ffc99e5956fd8d285c5bb",
      "tenantId": "6a4ffc99e5956fd8d285c5aa",
      "channelType": "whatsapp",
      "channelId": "573001234567",
      "phoneNumber": "+573001234567",
      "displayName": "Carlos Mendoza",
      "tags": ["cliente-vip", "cita-confirmada"],
      "labelIds": ["603d2b2fe71c2100155b41d0"],
      "createdAt": "2026-08-10T14:20:00.000Z",
      "updatedAt": "2026-08-15T09:12:00.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 10,
  "totalPages": 1,
  "hasNextPage": false,
  "hasPrevPage": false
}
¿Esta documentación fue útil para configurar tu integración?