> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lyzn.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# WhatsApp Search Contacts Tool

> AI tool to search and retrieve WhatsApp contacts

# WhatsApp Search Contacts Tool

AI tool to search and retrieve WhatsApp contacts

## Properties

| Property   | Value                         |
| ---------- | ----------------------------- |
| **Type**   | whatsapp-tool-search-contacts |
| **Family** | AI                            |
| **Group**  | Tools                         |

## Parameters

| Name            | Label            | Type   | Description                                                  | Required |
| --------------- | ---------------- | ------ | ------------------------------------------------------------ | -------- |
| toolName        | Tool Name        | String | Name of the tool for the AI to call                          | Yes      |
| toolDescription | Tool Description | String | Description of what this tool does                           | Yes      |
| query           | Search Query     | String | Name or phone number to search for                           | No       |
| limit           | Limit            | Number | Maximum number of contacts to return (default: 20, max: 100) | No       |
| include\_groups | Include Groups   | Bool   | Whether to also search and return groups                     | No       |

## Outputs

| Name     | Label    | Type   | Description      |
| -------- | -------- | ------ | ---------------- |
| toolName | toolName | string | Name of the tool |
| toolType | toolType | string | Type of tool     |