Evolution API icon

Evolution API

Interact with Evolution API

Overview

The "Find Participants" operation of the Group resource in this node interacts with the Evolution API to retrieve a list of participants from a specified group. This is useful when you need to programmatically access or manage the members of a group within an instance of the Evolution platform.

Common scenarios include:

  • Fetching current group members for auditing or reporting.
  • Synchronizing group participant data with other systems.
  • Triggering workflows based on group membership changes.

For example, you might use this node to get all participants of a project team group before sending them a notification or updating their roles elsewhere.

Properties

Name Meaning
Instance Name The name of the Evolution API instance you want to connect to.
Group ID The unique identifier (ID) of the group whose participants you want to fetch.

Output

The node outputs a JSON array where each element represents a participant in the specified group. Each participant object typically contains details such as participant identifiers, names, roles, or statuses as provided by the Evolution API.

If the API supports binary data related to participants (e.g., profile pictures), the node would handle it accordingly, but based on the provided code and properties, the output focuses on JSON participant data.

Dependencies

  • Requires an active connection to the Evolution API via an API key or authentication token configured in the node credentials.
  • The base URL for API requests is https://doc.evolution-api.com/api-reference.
  • Proper permissions to access group participant information in the Evolution instance.

Troubleshooting

  • Unsupported operation error: If you see an error stating the operation is unsupported, verify that the Resource is set to "Group" and Operation to "Find Participants". Also, ensure the node version supports this operation.
  • Invalid or missing Group ID: Ensure the Group ID is correctly entered and corresponds to an existing group in your Evolution instance.
  • Authentication errors: Confirm that the API credentials are valid and have sufficient permissions.
  • Empty results: If no participants are returned, check if the group actually has members or if the Group ID is correct.

Links and References

Discussion