Evolution API icon

Evolution API

Interact with Evolution API
Join our community

Actions64

Overview

The node "Evolution API" allows interaction with the Evolution API service. Specifically, for the Resource "Chat" and Operation "Listar Contatos" (List Contacts), it retrieves a list of contacts from the specified chat instance. This operation can either fetch all contacts or a specific contact by its identifier.

This node is useful in scenarios where you want to automate the retrieval of contact information from a chat system integrated via the Evolution API. For example, you might use it to synchronize contacts with another system, generate reports on chat users, or trigger workflows based on contact data.

Properties

Name Meaning
Nome Da Instância The name of the chat instance to connect to.
Listar Todos Boolean option to list all contacts (true) or a specific contact (false).
Contato The identifier (number) of a specific contact to retrieve; used only if "Listar Todos" is false.

Output

The node outputs an array of JSON objects representing the contacts retrieved from the Evolution API. Each object corresponds to a contact's details as returned by the API. The exact structure depends on the API response but typically includes identifiers, names, and possibly other metadata about each contact.

If binary data were involved, it would be summarized here, but this node focuses on JSON contact data.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node expects the Evolution API endpoint to be accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication.

Troubleshooting

  • Operation not supported error: If you select an unsupported operation or resource, the node throws an error indicating the function is not supported. Ensure that the Resource is set to "Chat" and Operation to "Listar Contatos".
  • Missing or invalid credentials: The node requires valid API credentials. Verify that the API key or token is correctly configured in n8n.
  • Empty or incorrect instance name: Providing an incorrect or empty instance name will likely result in no data or errors. Double-check the instance name input.
  • Incorrect contact number when listing a specific contact: If "Listar Todos" is false but the contact number is invalid or missing, the node may fail or return no results.

Links and References

Discussion