Evolution API icon

Evolution API

Complete WhatsApp automation with Evolution API
Join our community

Actions48

Overview

The "Get Participants" operation of the "Group" resource in this node allows you to retrieve the list of participants in a specified WhatsApp group. This is useful for scenarios where you need to monitor or manage group membership, such as auditing group members, sending targeted messages, or automating administrative tasks based on participant data.

Practical examples:

  • Automatically fetching and logging all participants of a group for compliance or record-keeping.
  • Triggering workflows when certain users join or leave a group by comparing participant lists over time.
  • Integrating with CRM systems to update contact statuses based on group participation.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group whose participants you want to retrieve.
Additional Fields Optional parameters that can modify behavior (not used specifically in this operation).

The "Additional Fields" collection includes:

  • Delay: Delay in milliseconds before sending (general purpose, not specific here).
  • Link Preview: Enable link preview in messages (not relevant here).
  • Quoted Message ID: ID of message to quote/reply to (not relevant here).
  • Mentions: Comma-separated list of numbers to mention (not relevant here).

For the "Get Participants" operation, only the Group ID is required and relevant.

Output

The output JSON contains the response from the API endpoint that returns the participants of the specified WhatsApp group. The structure typically includes details about each participant such as their WhatsApp ID and possibly roles or statuses within the group.

Example output structure (simplified):

{
  "participants": [
    "participant1@s.whatsapp.net",
    "participant2@s.whatsapp.net",
    ...
  ],
  "groupJid": "group_id@s.whatsapp.net",
  "subject": "Group Name",
  "creation": "timestamp"
}

This output can be used downstream in your workflow to process participant information.

Dependencies

  • Requires an active connection to the Evolution API service for WhatsApp automation.
  • Needs valid credentials including an API key and instance name configured in n8n.
  • Optionally uses a secondary API validation service to verify subscription and API key validity before making requests.
  • The node sends HTTP POST requests to the Evolution API endpoints.

Troubleshooting

  • Invalid Credentials or Subscription:
    If the node throws errors related to invalid API keys or subscription issues, verify that your API key credential is correct and that your subscription to the Evolution API service is active.

  • Unknown Resource or Operation Errors:
    These occur if the resource or operation parameter is set incorrectly. Ensure "Group" is selected as the resource and "Get Participants" as the operation.

  • Network or API Endpoint Issues:
    Failures in HTTP requests may indicate network problems or downtime of the Evolution API service. Check connectivity and API status.

  • Empty or Unexpected Response:
    If the participants list is empty or missing, confirm the Group ID is correct and that the bot/instance has access to the group.

Links and References

Discussion