Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node "Evolution API" provides integration with the Evolution API service, allowing users to interact programmatically with various resources and operations exposed by this API. Specifically, for the Resource "Grupo" and Operation "Buscar Grupos," the node enables searching for groups using different methods such as invitation code, group ID, or fetching all groups. This is useful in scenarios where you need to retrieve group information dynamically within an n8n workflow, for example, to automate group management, synchronize group data, or trigger actions based on group membership.

Practical examples:

  • Fetching a specific group’s details by its invitation code to verify membership or access rights.
  • Retrieving all groups from an instance to generate reports or perform bulk updates.
  • Obtaining participant lists of groups when managing communications or notifications.

Properties

Name Meaning
Nombre De La Instancia The name of the instance where the groups are managed; required to identify the target environment.
Método De Búsqueda The method used to search for groups. Options: "Por Código De Invitación", "Por ID Del Grupo", "Buscar Todos Los Grupos".
Código De Invitación Invitation code of the group (e.g., JZNHJLvnNd04UvGefiEZAA). Required if searching by invitation code.
ID Del Grupo Group ID used to fetch specific group information. Required if searching by group ID.
Obtener Participantes Boolean flag indicating whether to retrieve the list of participants for all fetched groups. Only applicable when fetching all groups.

Output

The node outputs JSON data representing the group(s) information retrieved from the Evolution API. The structure depends on the search method:

  • When searching by invitation code or group ID, the output contains details of the single matched group.
  • When fetching all groups, the output includes an array of group objects, optionally including participant lists if requested.

If participant data is included, it will be nested within each group object under a relevant property.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating requests to the Evolution API.
  • The base URL for API requests is set to https://doc.evolution-api.com/api-reference.
  • Proper configuration of the API credential in n8n is necessary for successful execution.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing an incorrect or empty invitation code or group ID will result in no data found or errors.
    • Selecting incompatible options (e.g., requesting participants when not fetching all groups) may lead to unexpected results.
  • Error messages:

    • "Operação não suportada." indicates that the selected operation is not implemented for the chosen resource.
    • Errors related to network or API response should be checked by verifying API availability and credentials.
  • Resolutions:

    • Ensure all required properties are filled correctly according to the selected search method.
    • Verify API credentials and permissions.
    • Confirm the instance name matches the target environment.

Links and References

Discussion