Actions66
- Account Actions
- API Key Actions
- Chat Actions
- Contact Actions
- Group Actions
- Media Actions
- Message Actions
- Queue Actions
- Sync Actions
- System Actions
- Webhook Actions
Contact → Get Many
AI-generatedSummary
Search WhatsApp contacts by a text fragment in their name, phone number, or JID, or list contacts when Search is empty. Use the selected account’s contacts to identify someone before messaging them.
Inputs
- Account Name or ID — WhatsApp account to search. If the API key is bound to one account, it can be selected automatically; with access to multiple accounts, choose one.
- Search — Text to match within a contact’s name, phone number, or JID. Leave empty to list all contacts.
- Return All — Whether to return all matching contacts. Defaults to false.
- Limit — Maximum number of contacts when Return All is false. Defaults to 50; minimum is 1.
Output shape
A list of contact items, one per returned contact.
Each item contains the contact data returned by the API, including its ID, name, phone, and JID. Results are fetched in pages; with Return All off, the list is capped at Limit.