Actions114
- Instance Actions
- Message Actions
- Group Actions
- Chat Actions
- Profile Actions
- Event Actions
- Integration Actions
- Call Actions
- Label Actions
- OpenAI Actions
- N8N Integration Actions
- EvoAI Actions
- Template Actions
- Business Actions
Group → Fetch Groups
AI-generatedOverview
This node interacts with the Evolution API to fetch group information based on different search methods. It supports fetching groups by invite code, by group ID, or fetching all groups. Additionally, when fetching all groups, it can optionally retrieve the list of participants for each group. This node is useful for scenarios where you need to manage or analyze group data from the Evolution API, such as retrieving group details for communication or administrative purposes.
Use Case Examples
- Fetch a specific group using its invite code to get detailed information about that group.
- Fetch a group by its unique group ID to access its metadata.
- Fetch all groups in an instance and optionally include the list of participants for each group to manage group memberships.
Properties
| Name | Meaning |
|---|---|
| Instance Name | The name of the instance from which to fetch group data. This is required to identify the specific Evolution API instance to query. |
| Search Method | The method used to fetch groups, which can be by invite code, by group ID, or fetching all groups. |
| Invite Code | The invite code of the group, required when the search method is 'By Invite Code'. |
| Group ID | The unique ID of the group, required when the search method is 'By Group ID'. |
| Get Participants | A boolean flag indicating whether to retrieve the list of participants for each group when fetching all groups. |
Output
JSON
groupId- The unique identifier of the group.groupName- The name of the group.inviteCode- The invite code associated with the group.participants- An optional list of participants in the group, included if 'Get Participants' is set to true.
Dependencies
- Evolution API service with required API key credentials
Troubleshooting
- Ensure the 'Instance Name' is correctly specified to avoid connection errors.
- If fetching by invite code or group ID, verify that the provided code or ID is valid and exists.
- When fetching all groups with participants, the response might be large; consider performance implications.
- Common errors include unsupported operation errors if the resource or operation names are incorrect, and API authentication errors if credentials are missing or invalid.
Links
- Evolution API Documentation - Official documentation for the Evolution API, useful for understanding available endpoints and data structures.