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 platform. Users can search groups by invite code, group ID, or fetch all groups. Optionally, it can also retrieve the list of participants in the groups.

Common scenarios include:

  • Retrieving detailed information about a specific group using its invite code or group ID.
  • Listing all groups available in an instance.
  • Obtaining participant lists for groups when managing or auditing group memberships.

Practical examples:

  • A user wants to get details of a group by entering its invite code to display group metadata.
  • An admin needs to fetch all groups in their instance to monitor activity or perform bulk operations.
  • Fetching participants of all groups to analyze membership distribution.

Properties

Name Meaning
Nome Da Instância The name of the instance where the groups are located; required to specify the target scope.
Método De Busca The method used to search 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 search for; required if searching by invite code.
ID Do Grupo The group ID to search for; required if searching by group ID.
Obter Participantes Boolean flag indicating whether to retrieve the list of participants for the groups (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 details of the single matched group.
  • When fetching all groups, the output is an array of group objects.
  • If "Obter Participantes" is enabled during fetching all groups, each group object includes a list of its participants.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API service.
  • The node expects the user to configure this API authentication within n8n credentials.
  • No other external dependencies are evident from the static code.

Troubleshooting

  • Operation not supported error: If the selected operation or resource is not implemented, the node throws an error stating the operation is unsupported. Ensure that the resource is set to "groups-api" and operation to "fetch-groups".
  • Missing required parameters: If required fields like instance name, invite code, or group ID are missing based on the chosen search method, the node will likely fail. Make sure to provide all mandatory inputs.
  • API authentication issues: Failure to authenticate with the Evolution API due to invalid or missing API keys will prevent successful execution.
  • Empty results: Searching by incorrect invite codes or group IDs may return no data. Verify input values carefully.

Links and References

Discussion