Evolution API NKInstall

Summary

Search for groups in the Evolution API NK by invite code, group ID, or fetch all groups from a specified instance.

Inputs

• Nome Da Instância (required) — Specify the name of the Evolution API instance to query.
• Método De Busca (required) — Select the method to search groups: by invite code, by group ID, or fetch all groups.
• Código Do Convite — Provide the invite code of the group to search for (required if searching by invite code).
• ID Do Grupo — Provide the group ID to search for (required if searching by group ID).
• Obter Participantes — Choose whether to include the list of group participants when fetching all groups.

Output shape

a JSON array containing the group or groups matching the search criteria, including group details and optionally participant lists.

The output shape depends on the search method; searching by invite code or group ID returns the specific group matching that identifier, while fetching all returns all groups from the instance. Inclusion of participants applies only when fetching all groups.

Examples

Example 1: Fetch a group by its invite code

Set 'Nome Da Instância' to target instance, 'Método De Busca' to 'Por Código De Convite', and input the invite code in 'Código Do Convite'.

Example 2: Retrieve all groups with participants

Set 'Nome Da Instância' to target instance, 'Método De Busca' to 'Buscar Todos Os Grupos', and enable 'Obter Participantes' to true.