New Evolution APIInstall

Summary

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

Inputs

• Instance Name or ID (required) — Select or specify the Evolution API WhatsApp instance by name or ID to query contacts from.
• Listar Todos (required) — Boolean flag to indicate if all contacts should be listed (true) or only a specific contact (false).
• Contato (required) — The phone number of the specific contact to retrieve; required only if listing all contacts is false.

Output shape

a JSON array of contact objects

Returns all contacts when 'Listar Todos' is true, or a single contact's information when false. Outputs are returned as JSON array(s). Error envelopes may apply if the instance is not found or the contact number is invalid.

Examples

Example 1: List all contacts from the specified instance

Set 'Instance Name or ID' to the desired WhatsApp instance, 'Listar Todos' to true.

Example 2: List a specific contact by number

Set 'Instance Name or ID' to the desired WhatsApp instance, 'Listar Todos' to false, and provide the contact number in 'Contato'.