El campo Options dentro de los nodos de n8n permite ajustar y refinar el comportamiento de las solicitudes hechas a la API. Proporciona seis parámetros principales: Search, Include, Order, Page, PerPage y Query.
A continuación se muestra la explicación detallada de cada uno, con ejemplos prácticos:

Search

Permite buscar registros que contengan un término específico.

• Ejemplo: al escribir Pedro, la API devuelve solo registros relacionados con ese nombre.
• Ideal para localizar contactos, usuarios o empresas sin necesidad de recorrer toda la base.

Order

Controla el orden de visualización de los resultados.

• Para orden ascendente (predeterminado), basta con informar el campo directamente.
  Ejemplo: created_at → ordena de más antiguo a más reciente.
• Para nombres o textos, la ordenación será de A → Z (como en la imagen).
• Para orden descendente, se debe agregar un guion - antes del campo.
  Ejemplo: -created_at → ordena de más reciente a más antiguo.

Page

Define qué página de resultados debe mostrarse cuando la API trabaja con paginación.

• Ejemplo: si hay 200 registros y el límite es de 50 por página, la página 2 mostrará del registro 51 al 100.
  Muy útil al trabajar con grandes volúmenes de datos.

PerPage

Determina cuántos registros se mostrarán en cada página.

• Ejemplo: establecer 100 registros por página en lugar del valor predeterminado (generalmente 20 o 50).
  Permite mayor control sobre el rendimiento y la cantidad de información devuelta.

Query

Funciona como un campo en blanco para filtros personalizados.
Es posible escribir manualmente las condiciones deseadas, de acuerdo con los parámetros aceptados por la API.
Ejemplos prácticos:

• name=Pedro → devuelve solo registros cuyo nombre sea “Pedro”.
• id=7 → devuelve solo el registro con el ID 7.

También es posible combinar diferentes filtros, dependiendo de las reglas de la API utilizada.

Include

El parámetro Include se utiliza para traer información adicional junto con los datos principales de cada solicitud.
Cada nodo posee Includes específicos, pero algunos se repiten en diferentes nodos.

Consejo: si no encuentras la explicación de un Include en el nodo que estás consultando, verifica si el mismo Include aparece en otro nodo. Como los datos devueltos son estandarizados, la explicación generalmente también será válida.

A continuación, se enumeran los Includes disponibles en cada nodo, con explicaciones prácticas de uso:

1. List Teams

Cuando el nodo devuelve equipos, es posible incluir datos adicionales relacionados con el equipo.

• Key → Identificador del equipo.
  Ejemplos: financiero, comercial, preventa, onboarding, soporte-técnico, posventa, expansión.
• Status → Situación del equipo.
  Valores posibles: active, inactive, online, offline, unavailable.
• Visibility → Define si el equipo es público o privado.
  Valores: public, private.
• Staging → Etapa del equipo.
  Valor común: requested.
• Attributes → Información adicional del equipo.
  Ejemplo: name (Comercial, Financiero, etc.), description.
• Users → Lista de usuarios asociados al equipo.
  Incluye: estado del usuario, estado del servicio, email, ID, nombre.
• Metadata → Información de creación y actualización.
  Campos: created_at, updated_at.

2. List and Search Contact

Permite buscar y listar contactos, con posibilidad de incluir datos complementarios.

• Type → Tipo de contacto.
  Valores: person o group.
• Chat status → Estado de la conversación.
  Valores: chat_closed, chat_in_progress.
• Read status → Estado de lectura de los mensajes.
  Valores: read, unread.
• Attributes → Datos básicos del contacto.
  Ejemplo: name, phone, email, cpf/cnpj.
• Account → Datos de la cuenta asociada al contacto.
  Ejemplo: name, cnpj, phone, segment, account_uuid.
• Attendant → Agente responsable del contacto.
  Ejemplo: name, attendant_uuid.
• Contact channels → Canales asociados al contacto.
  Campos: channel_uuid, provider (WhatsApp, etc.), type (default).
• Current attendance → Información de la atención actual.
  Incluye: status, type (ej.: INITIATED_BY_FORWARDING, INITIATED_BY_BUSINESS), además de metadata (created_at, updated_at).
• Last message → Último mensaje intercambiado con el contacto.
  Incluye: timestamp, provider, metadata, components (contenido del mensaje).
• Tags → Etiquetas aplicadas al contacto.
  Campos: tag_uuid, name, color.
• Addresses → Direcciones vinculadas al contacto.
• Metadata → Información adicional de creación y actualización.

3. List Messages from Contact ID

Se utiliza para visualizar mensajes específicos de un contacto.

• Components → Representa el cuerpo del mensaje.
  Ejemplo: body (el texto del mensaje en sí).

4. List and Search Users

Proporciona información sobre los usuarios del sistema, permitiendo incluir detalles adicionales.

• Status → Estado del usuario.
  Ejemplo: active, inactive.
• Status of service → Disponibilidad para la atención.
  Ejemplo: available, unavailable.
• Email → Email registrado del usuario.
• Attributes → Información adicional.
  Ejemplo: name.
• Roles → Roles asignados al usuario.
  Ejemplos: gestor, supervisor, operador de chat.
  Incluye: UUID del rol y metadata.
• Permissions → Permisos del usuario.
  Ejemplo: ver canales, ver contactos, enviar mensajes, etc.
  Incluye: UUID de los permisos.
• Active account → Cuenta activa vinculada al usuario.
  Campos: account_uuid, metadata, name, cnpj.
• Account channels → Canales asociados a la cuenta.
  Ejemplo: name, channel_uuid, status, provider.
• Accounts → Otras cuentas/empresas vinculadas al usuario.
• Teams → Equipos de los que forma parte el usuario.
  Ejemplo: comercial, financiero, preventa, etc.
• Addresses → Direcciones registradas.
• Metadata → Información de creación y actualización.

5. List Channels

Permite listar canales de comunicación, incluyendo información adicional.
(Los Includes aquí son similares a los de contactos, ya que están directamente relacionados con el flujo de comunicación.)

• Type → Tipo de canal.
• Chat status → Estado de la conversación en el canal.
• Read status → Estado de lectura.
• Attributes → Datos adicionales del canal.
• Account → Cuenta asociada al canal.
• Attendant → Usuario responsable.
• Contact channels → Enlaces entre canal y contacto.
• Current attendance → Atención activa.
• Last message → Último mensaje recibido o enviado.
• Tags → Etiquetas aplicadas.
• Addresses → Direcciones vinculadas.
• Metadata → Información de creación y actualización.

6. Get Channel

En el nodo Get Channel, el único Include disponible es Config, que devuelve la información de configuración del canal de WhatsApp.

• business_id → ID de la empresa en Business Manager.
• business_name → Nombre de la empresa en Business Manager.
• waba_id → ID de la cuenta WhatsApp Business (WABA).
• waba_name → Nombre de la cuenta WABA (ej.: [Prod][Oficial] Poli).
• phone_id → Identificador del número de WhatsApp registrado.
• phone_name → Nombre asignado al número (ej.: Poli).
• phone_number → Número de WhatsApp vinculado al canal (en formato internacional).
• business_management → Datos de gestión del número y de la cuenta.
• phone_id → UUID interno del número.
• whatsapp_account_id → UUID interno de la cuenta de WhatsApp.