Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The "Fetch Groups" operation in the "Group" resource of this node allows users to retrieve information about groups from the Evolution API. It supports multiple search methods to find groups by invite code, by group ID, or to fetch all groups. This node is useful for scenarios where you need to programmatically access group details or participant lists, such as managing group memberships, monitoring group activity, or integrating group data into other workflows.

Practical examples include:

  • Fetching a specific group’s details using its invite code.
  • Retrieving group information by providing a unique group ID.
  • Listing all available groups and optionally retrieving their participants.

Properties

Name Meaning
Name Da Instância The name of the instance to connect with (required).
Método De Busca The method to search for groups. Options: "Por Código De Convite" (by invite code), "By Group ID", "Search All Groups". (required)
Código Do Convite The invite code of the group to fetch (required if searching by invite code).
Group ID The unique identifier of the group to fetch (required if searching by group ID).
Get Participants Boolean flag indicating whether to retrieve the list of participants for each group (only applicable when fetching all groups).

Output

The node outputs an array of JSON objects representing the fetched group(s). Each object contains the group's details according to the selected search method. If the "Get Participants" option is enabled when fetching all groups, the output will also include a list of participants for each group.

If binary data were involved (e.g., group media), it would be summarized here, but this node focuses on JSON data only.

Dependencies

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

Troubleshooting

  • Common Issues:

    • Missing or incorrect API credentials will cause authentication failures.
    • Providing an invalid invite code or group ID will result in no data found or error responses.
    • Selecting incompatible options (e.g., not providing invite code when required) will cause validation errors.

  • Error Messages:

    • "Operação não suportada." indicates that the chosen operation is not supported for the selected resource.
    • Validation errors occur if required parameters are missing based on the selected search method.

  • Resolutions:

    • Ensure the API key credential is correctly set up and valid.
    • Double-check input parameters for correctness and completeness.
    • Select the appropriate search method and provide corresponding required fields.

Links and References

Discussion