Actions113
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Canned Response Actions
- Custom Attributes Actions
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Teams Actions
- Custom Filters Actions
- Webhooks Actions
- Reports Actions
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
Overview
This node allows you to search for contacts within a specified account using various criteria such as name, identifier, email, or phone number. It is useful in scenarios where you need to quickly find contact details from a large list, filter contacts based on specific attributes, or integrate contact search functionality into automated workflows.
Practical examples include:
- Searching for a customer by email before sending a targeted marketing campaign.
- Retrieving contact information by phone number to verify user identity.
- Sorting contacts by last activity date to prioritize recent interactions.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account to which the contacts belong. This is required for the search. |
| Q | A search query string that can match contact name, identifier, email, or phone number. |
| Sort | Attribute to sort the results by. Options: Name, Email, Phone Number, Last Activity At. Each can be sorted ascending or descending (indicated by a leading dash). |
| Page | The page number of the paginated results to retrieve. Defaults to 1. |
Output
The node outputs JSON data containing the search results for contacts matching the query within the specified account. The structure typically includes an array of contact objects with their details such as name, email, phone number, and other relevant metadata.
If binary data were involved (e.g., profile pictures), it would be included separately, but this node focuses on JSON contact data only.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- Needs the base URL of the ChatWoot instance configured in credentials.
- Depends on the ChatWoot REST API being accessible and responsive.
Troubleshooting
Common issues:
- Invalid or missing account ID will cause the search to fail.
- Incorrect API credentials or base URL will result in authentication errors.
- Providing an empty or malformed search query may return no results or errors.
- Pagination parameters out of range might lead to empty responses.
Error messages:
- Authentication failures usually indicate invalid API keys or misconfigured credentials.
- "Account not found" or similar errors suggest the provided account ID does not exist.
- Rate limiting errors from the API require waiting or adjusting request frequency.
To resolve these, verify the account ID, ensure correct API credentials, validate the search query format, and check API usage limits.