Maytapi icon

Maytapi

Integrate with Maytapi WhatsApp Unofficial API

Actions55

Group → Get Groups

AI-generated

Overview

The "Get Groups" operation of the Maytapi node retrieves WhatsApp groups associated with a specified WhatsApp instance (Phone ID). It allows users to fetch a list of groups with options to include detailed participant information, sort the groups by their IDs, include invite links, and paginate through results.

This operation is useful for scenarios where you want to:

  • Monitor or manage WhatsApp groups linked to your WhatsApp Business API instance.
  • Retrieve group metadata and optionally participants for analytics or automation workflows.
  • Access invite links to share or manage group invitations programmatically.

Practical example:
A business using WhatsApp for customer support can use this operation to get all active support groups, load full participant details to analyze engagement, and retrieve invite links to send new invitations automatically.

Properties

Name Meaning
Phone ID Source Select how to provide the Phone ID: either "From Credentials" (default) or "Custom" (manual input).
Phone ID The custom Phone ID of your WhatsApp instance (required if "Custom" is selected as Phone ID Source).
Load Full Details Boolean option to load participants for each group. Maximum response limit: 100 participants.
Sort Groups Boolean option to sort the returned groups by their ID.
Include Invite Links Boolean option to include invite links for groups in the response. Maximum response limit: 50 invite links.
Page Number Number for pagination to specify which page of groups to retrieve. Suggested to use with Sort Groups option. Default is 1.

Output

The output JSON contains an array of group objects retrieved from the WhatsApp instance. Each group object may include:

  • Basic group information such as group ID, name, and other metadata.
  • If "Load Full Details" is enabled, participant details are included within each group object.
  • If "Include Invite Links" is enabled, invite links for groups are included (limited to 50).
  • Pagination is supported via the "Page Number" property.

The exact structure depends on the API response but generally includes group identifiers, names, participant lists, and invite links when requested.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Maytapi WhatsApp Unofficial API.
  • The Phone ID must be provided either via credentials or manually as a custom value.
  • The node makes HTTP requests to the Maytapi API endpoint https://api.maytapi.com/api.
  • Proper configuration of the API key and Phone ID is necessary for successful calls.

Troubleshooting

  • Missing Phone ID error: If neither credentials nor custom Phone ID is provided, the node throws "Phone ID is required." Ensure that the Phone ID is set correctly.
  • API limits: Loading full participant details or including invite links has maximum response limits (100 participants, 50 invite links). Exceeding these may cause incomplete data or errors.
  • Pagination issues: When using pagination, ensure the "Page Number" is valid and used together with sorting to maintain consistent results.
  • Network or authentication errors: Verify that the API key credential is valid and that the Maytapi service is reachable.
  • Invalid parameter values: For example, providing non-numeric or out-of-range values for "Page Number" may cause errors.

Links and References

Discussion