Evolution API NKInstall

Summary

Retrieve a list of chat contacts from a specified Evolution API instance, either all contacts or a specific contact by its number.

Inputs

• Nome Da Instância (required) — The name of the Evolution API instance to query.
• Listar Todos (required) — Boolean indicating whether to list all contacts (true) or a specific contact (false).
• Contato (required) — The contact number (remoteJid) to retrieve when not listing all contacts. Required only if 'Listar Todos' is false.

Output shape

a JSON array of contact objects

Returns an array containing all contacts if 'Listar Todos' is true; otherwise returns an array with the specified contact's details. The output shape depends on the 'Listar Todos' parameter. Errors occur if the operation is unsupported or parameters are missing.

Examples

Example 1: List all contacts in the instance

Set 'Nome Da Instância' to the instance name, 'Listar Todos' to true, and omit 'Contato'.

Example 2: Retrieve a specific contact

Set 'Nome Da Instância' to the instance name, 'Listar Todos' to false, and provide the 'Contato' number.