O campo Options dentro dos nodes do n8n permite ajustar e refinar o comportamento das requisições feitas à API. Ele disponibiliza seis parâmetros principais: Search, Include, Order, Page, PerPage e Query.

A seguir está a explicação detalhada de cada um, com exemplos práticos:

Search

Permite buscar registros que contenham um termo específico.

• Exemplo: ao digitar Pedro, a API retorna apenas registros relacionados a esse nome.
• Ideal para localizar contatos, usuários ou empresas sem precisar percorrer toda a base.
  

Order

Controla a ordem de exibição dos resultados.

• Para ordem crescente (padrão), basta informar o campo diretamente.
• • Exemplo: created_at → ordena do mais antigo para o mais recente.
  • Para nomes ou textos, a ordenação será de A → Z. (conforme a imagem)
• Para ordem decrescente, deve-se adicionar um traço - antes do campo.
• Exemplo: -created_at → ordena do mais recente para o mais antigo.
  

Page

Define qual página de resultados deve ser exibida quando a API trabalha com paginação.

• Exemplo: se houver 200 registros e o limite for de 50 por página, a página 2 mostrará do registro 51 ao 100.
• Muito útil quando se trabalha com grandes volumes de dados.

PerPage

Determina quantos registros serão exibidos em cada página.

• Exemplo: definir 100 registros por página em vez do padrão (geralmente 20 ou 50).
• Permite maior controle sobre desempenho e quantidade de informações retornadas.

Query

Funciona como um campo em branco para filtros personalizados.

• É possível digitar manualmente as condições desejadas, de acordo com os parâmetros aceitos pela API.
• Exemplos práticos:
• • name=Pedro → retorna apenas registros cujo nome seja “Pedro”.
  • id=7 → retorna apenas o registro com o ID 7.
  • Também é possível combinar diferentes filtros, dependendo das regras da API utilizada.
    

Include

O parâmetro Include é usado para trazer informações adicionais junto com os dados principais de cada requisição.
Cada node possui Includes específicos, mas alguns se repetem em diferentes nodes.

Dica: caso não encontre a explicação de um Include no node que está pesquisando, verifique se o mesmo Include aparece em outro node. Como os dados retornados são padronizados, a explicação geralmente será válida também.

A seguir, estão listados os Includes disponíveis em cada node, com explicações práticas de uso.

1. List Teams

Quando o node retorna times (equipes), é possível incluir dados extras relacionados à equipe.

• Key → Identificador do time.
• • Exemplos: financeiro, comercial, pré-vendas, onboarding, suporte-técnico, pós-venda, expansão.
• Status → Situação do time.
• • Valores possíveis: active, inactive, online, offline, unavailable.
• Visibility → Define se o time é público ou privado.
• • Valores: public, private.
• Staging → Etapa do time.
• • Valor comum: requested.
• Attributes → Informações adicionais do time.
• • Exemplo: name (Comercial, Financeiro etc), description.
• Users → Lista de usuários associados ao time.
• • Inclui: status do usuário, status do serviço, email, ID, nome.
• Metadata → Informações de criação e atualização.
• • Campos: created_at, updated_at.

2. List and Search Contact

Permite buscar e listar contatos, com possibilidade de incluir dados complementares.

• Type → Tipo de contato.
• • Valores: person ou group.
• Chat status → Estado da conversa.
• • Valores: chat_closed, chat_in_progress.
• Read status → Situação de leitura das mensagens.
• • Valores: read, unread.
• Attributes → Dados básicos do contato.
• • Exemplo: name, phone, email, cpf/cnpj.
• Account → Dados da conta associada ao contato.
• • Exemplo: name, cnpj, phone, segment, account_uuid.
• Attendant → Atendente responsável pelo contato.
• • Exemplo: name, attendant_uuid.
• Contact channels → Canais associados ao contato.
• • Campos: channel_uuid, provider (WhatsApp etc.), type (default).
• Current attendance → Informações do atendimento atual.
• • Inclui: status, type (ex.: INITIATED_BY_FORWARDING, INITIATED_BY_BUSINESS), além de metadata (created_at, updated_at).
• Last message → Última mensagem trocada com o contato.
• • Inclui: timestamp, provider, metadata, components (conteúdo da mensagem).
• Tags → Etiquetas aplicadas ao contato.
• • Campos: tag_uuid, name, color.
• Addresses → Endereços vinculados ao contato.
• Metadata → Informações adicionais de criação e atualização.

3. List Messages from Contact ID

Usado para visualizar mensagens específicas de um contato.

• Components → Representa o corpo da mensagem.
• • Exemplo: body (texto da mensagem em si).

4. List and Search Users

Traz informações sobre usuários do sistema, permitindo incluir detalhes extras.

• Status → Status do usuário.
• • Exemplo: active, inactive.
• Status of service → Disponibilidade para atendimento.
• • Exemplo: available, unavailable.
• Email → Email cadastrado do usuário.
• Attributes → Informações adicionais.
• • Exemplo: name.
• Roles → Papéis atribuídos ao usuário.
• • Exemplos: gestor, supervisor, operador de chat.
  • Inclui: UUID do papel e metadata.
• Permissions → Permissões do usuário.
• • Exemplo: visualizar canais, ver contatos, enviar mensagens etc.
  • Inclui: UUID das permissões.
• Active account → Conta ativa vinculada ao usuário.
• • Campos: account_uuid, metadata, name, cnpj.
• Account channels → Canais associados à conta.
• • Exemplo: name, channel_uuid, status, provider.
• Accounts → Outras contas/empresas vinculadas ao usuário.
• Teams → Equipes das quais o usuário faz parte.
• • Exemplo: comercial, financeiro, pré-venda etc.
• Addresses → Endereços cadastrados.
• Metadata → Informações de criação e atualização.

5. List Channels

Permite listar canais de comunicação, incluindo informações adicionais.
(Os Includes aqui são semelhantes aos de contatos, pois estão diretamente relacionados ao fluxo de comunicação.)

• Type → Tipo do canal.
• Chat status → Situação da conversa no canal.
• Read status → Status de leitura.
• Attributes → Dados adicionais do canal.
• Account → Conta associada ao canal.
• Attendant → Usuário responsável.
• Contact channels → Ligações entre canal e contato.
• Current attendance → Atendimento ativo.
• Last message → Última mensagem recebida ou enviada.
• Tags → Etiquetas aplicadas.
• Addresses → Endereços vinculados.
• Metadata → Informações de criação e atualização.

6. Get Channel

No node Get Channel, o único Include disponível é o Config, que retorna as informações de configuração do canal WhatsApp.

• business_id → ID da empresa no Business Manager.
• business_name → Nome da empresa no Business Manager.
• waba_id → ID da conta WhatsApp Business (WABA).
• waba_name → Nome da conta WABA (ex.: [Prod][Oficial] Poli).
• phone_id → Identificador do número de WhatsApp cadastrado.
• phone_name → Nome atribuído ao número (ex.: Poli).
• phone_number → Número do WhatsApp vinculado ao canal (em formato internacional).
• business_management → Dados de gerenciamento do número e da conta.
• • phone_id → UUID interno do número.
  • whatsapp_account_id → UUID interno da conta WhatsApp.