Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The Evolution API node for n8n allows you to interact with the Evolution API, specifically to list contacts via the "Listar Contatos" (List Contacts) operation under the "Chat" resource. This node is useful in scenarios where you need to retrieve contact information from your Evolution chat instance—either fetching all contacts or searching for a specific one by number. For example, you might use this node to synchronize your contact list with another system, automate messaging workflows, or build dashboards displaying contact data.

Properties

Below are the supported input properties for the "Chat" resource and "Listar Contatos" operation:

Display Name Type Meaning
Nome Da Instância String The name of the Evolution API instance you want to connect to. Required for all actions.
Listar Todos Boolean Whether to list all contacts (true) or search for a specific contact (false).
Contato String The phone number of a specific contact to search for. Only required if "Listar Todos" is set to false.

Output

  • The output is a JSON array containing the contact(s) retrieved from the Evolution API.
  • Each item in the array represents a contact object as returned by the API.
  • The exact structure of each contact object depends on the Evolution API's response, but typically includes fields such as contact ID, name, phone number, and other metadata.

Example Output:

[
  {
    "id": "12345@c.us",
    "name": "John Doe",
    "phone": "+5511999999999",
    "status": "online"
  }
]

Note: The actual fields may vary based on the Evolution API.

Dependencies

  • External Service: Requires access to the Evolution API.
  • API Key/Credentials: You must configure valid Evolution API credentials in n8n under the credential type evolutionApi.
  • n8n Configuration: No additional environment variables are required beyond standard credential setup.

Troubleshooting

  • Common Issues:

    • Missing or Invalid Credentials: If credentials are not configured or are incorrect, the node will fail to connect to the Evolution API.
    • Unsupported Operation: If an unsupported operation or resource is selected, the node will throw an error indicating that the function is not supported.
    • Required Fields Missing: If required fields like "Nome Da Instância" or "Contato" (when "Listar Todos" is false) are not provided, the node will not execute successfully.

  • Error Messages:

    • "Operação não suportada."
      Meaning: The selected operation is not available for the chosen resource.
      Resolution: Double-check that you have selected a valid combination of resource and operation.
    • Credential or connection errors will typically indicate issues with authentication or network connectivity.

Links and References

Tip: Always ensure your Evolution API instance is accessible and your credentials are up-to-date before running workflows using this node.

Discussion