Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

This node integrates with the Zappfy API to fetch information about groups. Specifically, for the "Grupo" resource and the "Buscar Grupos" operation, it allows users to search for groups by different methods: by invite code, by group ID, or fetch all groups associated with an instance. It can optionally retrieve the list of participants in the groups when fetching all groups.

Common scenarios include:

  • Retrieving detailed information about a specific group using its invite code or group ID.
  • Listing all groups available in a given instance, optionally including participant details.
  • Automating workflows that require group data synchronization or monitoring group membership.

Practical example:

  • A user wants to get the details of a WhatsApp group by providing its invite code to automate sending messages or managing group metadata.
  • An admin wants to fetch all groups from their instance and analyze participant lists for reporting purposes.

Properties

Name Meaning
Nome Da Instância The name of the instance to query groups from.
Método De Busca The method used to search for groups. Options: "Por Código De Convite", "Por ID Do Grupo", "Buscar Todos Os Grupos".
Código Do Convite The invite code of the group (e.g., JZNHJLvnNd04UvGefiEZAA). Required if searching by invite code.
ID Do Grupo The group ID to fetch information for. Required if searching by group ID.
Obter Participantes Boolean flag indicating whether to retrieve the list of participants when fetching all groups.

Output

The node outputs a JSON array where each item represents group data retrieved from the Zappfy API. The structure typically includes group metadata such as group ID, name, description, and possibly participant details if requested.

If the "Obter Participantes" option is enabled during a "fetchAll" search, the output will also contain participant lists for each group.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Zappfy API.
  • The base URL for API requests is https://docs.zappfy.io/api-reference.
  • Proper configuration of the API credential within n8n is necessary for successful execution.

Troubleshooting

  • Operation not supported error: If the selected operation or resource is not implemented, the node throws an error stating the operation is unsupported. Ensure the correct resource ("groups-api") and operation ("fetch-groups") are selected.
  • Missing required parameters: When searching by invite code or group ID, ensure these fields are filled; otherwise, the API call will fail.
  • API authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Empty results: If no groups are found, check that the instance name is correct and that the search parameters match existing groups.

Links and References

Discussion