Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

This node, named "Evolution API," allows users to interact with the Evolution API service. Specifically, for the Resource "Grupo" and Operation "Buscar Grupos," it enables fetching group information from the Evolution API based on different search methods. This is useful in scenarios where you need to retrieve details about groups such as their metadata or participants, for example, when managing group communications or integrating group data into workflows.

Practical examples include:

  • Fetching a group by its invite code to verify membership or access.
  • Retrieving group details using the group's unique ID.
  • Listing all groups available in an instance, optionally including participant lists.

Properties

Name Meaning
Nome Da Instância The name of the instance to connect to within the Evolution API environment.
Método De Busca The method used to search for groups. Options: "Por Código De Convite" (by invite code), "Por ID Do Grupo" (by group ID), "Buscar Todos Os Grupos" (fetch all groups).
Código Do Convite The invite code of the group to fetch (required if searching by invite code).
ID Do Grupo The unique identifier of the group to fetch (required if searching by group ID).
Obter Participantes Boolean flag indicating whether to retrieve the list of participants for each group (only applicable when fetching all groups).

Output

The node outputs JSON data representing the fetched group(s) information. The structure depends on the search method:

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

If the node supports binary data output, it is not indicated in the provided source or properties, so the output is purely JSON.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The base URL for requests is set to https://doc.evolution-api.com/api-reference.
  • No additional external dependencies are indicated beyond the Evolution API service itself.

Troubleshooting

  • Operation Not Supported Error: If the selected operation or resource is not supported, the node throws an error stating the operation is unsupported. Ensure that the correct resource ("groups-api") and operation ("fetch-groups") are selected.
  • Missing Required Parameters: Errors may occur if required parameters like "Nome Da Instância," "Código Do Convite," or "ID Do Grupo" are missing depending on the chosen search method. Verify all required fields are filled.
  • API Authentication Issues: If the API key credential is invalid or missing, requests will fail. Confirm that the API key is correctly configured in n8n credentials.
  • Empty Results: If no groups match the search criteria, the output may be empty. Double-check the invite code or group ID values.

Links and References

Discussion