Actions84
- Instance Actions
- Event Actions
- Message Actions
- Call Actions
- Group Actions
- Community Actions
- Newsletter Actions
- Profile Actions
- Chat Actions
- Get History
- Mark Chat Read
- Mark Message Read
- Pin Chat
- Pin Message
- Favorite
- Mute Chat
- Archive Chat
- Delete Chat
- Create Tag
- List Tags
- Assign Tag
- Get Contacts by Label
- Unassign Tag
- Delete Tag
- List Contacts
- Block Contact
- Send Presence
- Forward Message
- Edit Message
- Find Message
- Get Message Status
- Delete Message
- Get Media Base64
- Get Poll Votes
- Integration Actions
- Health Actions
Chat → Get Contacts by Label
AI-generatedSummary
Retrieve contacts filtered by assigned label names or IDs from a specified WhatsApp instance, optionally refreshing the contacts cache before query.
Inputs
- Instance Name or ID (required) — Specify the WhatsApp instance to operate on by selecting from the list or providing an ID via expression.
- Label (required) — Enter one or multiple comma-separated label names or IDs to filter contacts by their assigned labels.
- Refresh — Choose to refresh the contacts cache before querying to ensure up-to-date contact information.
- Request Options — Configure additional request parameters like batching, SSL validation, proxy, and timeout settings.
Output shape
a list of contacts matching the specified label filter.
If multiple labels are specified, contacts assigned any of those labels are returned. The 'Label' input distinguishes label names from IDs automatically. Results reflect the state of the contacts cache unless 'Refresh' is enabled. Pagination or batch handling is governed by optional request options if used.
Examples
Example 1: Get all contacts labeled 'VIP' or with label ID '1' from a specific WhatsApp instance, refreshing cache first.
Set 'Instance Name or ID' to the target instance, 'Label' to 'VIP,1', and enable 'Refresh'. The node returns the matching contacts list.