Actions50
- Event Actions
- Message Actions
- Instance Actions
- Group Actions
- Community Actions
- Contact Actions
- Chat Actions
- Profile Actions
Overview
This node interacts with the Z-API to search for WhatsApp groups. It allows users to retrieve a paginated list of groups, which is useful for managing or analyzing group data within WhatsApp. For example, it can be used to fetch groups for reporting or to automate group-related workflows.
Use Case Examples
- Retrieve the first page of WhatsApp groups with a page size of 10 to display in a dashboard.
- Fetch subsequent pages of groups to process or analyze group membership or activity.
Properties
| Name | Meaning |
|---|---|
| Page | Page number for pagination, specifying which page of groups to retrieve. |
| Page Size | Number of groups to return per page, controlling the size of each paginated result set. |
Output
JSON
groups- Array of group objects returned from the search operation.page- Current page number of the results.pageSize- Number of groups returned per page.totalGroups- Total number of groups available matching the search criteria.
Dependencies
- Requires an API key credential for Z-API to authenticate requests.
Troubleshooting
- Ensure the API key credential is correctly configured and has the necessary permissions to access group data.
- If pagination parameters (page or pageSize) are out of range, the API may return errors or empty results; verify these values are within allowed limits.
- Network or API service issues may cause request failures; check connectivity and Z-API service status.