Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The "Fetch Groups" operation of the Group resource in this node allows users to retrieve information about groups from the Evolution API. It supports fetching group details by different methods: using an invite code, a group ID, or fetching all groups available. This is useful for scenarios where you need to programmatically access group metadata or participant lists, such as managing group memberships, auditing group data, or integrating group info into other workflows.

Practical examples:

  • Fetching a specific group’s details by its invite code to display or process group info.
  • Retrieving a group by its unique ID to update or synchronize group data.
  • Fetching all groups and optionally their participants to maintain an up-to-date directory of groups.

Properties

Name Meaning
Instance Name The name of the instance to connect with the Evolution API.
Search Method The method used to fetch groups. Options: "By Invite Code", "By Group ID", "Fetch All Groups".
Invite Code The invite code of the group (required if searching by invite code). Example: JZNHJLvnNd04UvGefiEZAA.
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 when fetching all groups.

Output

The node outputs JSON data representing the fetched group(s) information. The structure typically includes group metadata such as group ID, name, description, and possibly participant details if requested. If the "Get Participants" option is enabled during a "Fetch All Groups" search, the output will also include arrays or lists of participants for each group.

No binary data output is indicated.

Dependencies

  • Requires connection to the Evolution API endpoint.
  • Needs an API authentication token or key configured in the node credentials to authorize requests.
  • The base URL for API requests is set to https://doc.evolution-api.com/api-reference.

Troubleshooting

  • Unsupported operation error: If the selected operation or resource is not supported, the node throws an error indicating the function is unsupported. Ensure that the Resource is set to "groups-api" and Operation to "fetch-groups".
  • Missing required parameters: Errors may occur if required fields like "Instance Name", "Invite Code", or "Group ID" are empty depending on the chosen search method. Verify all required inputs are provided.
  • API connectivity issues: Network errors or invalid credentials can cause failures. Confirm API keys are valid and network access to the Evolution API is available.
  • Empty results: If no groups are found for the given invite code or group ID, the output may be empty. Double-check the input values.

Links and References

Discussion