Actions113
- 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
- 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
Contacts → Contact Search
AI-generatedOverview
The node enables searching for contacts within a specified account in the ChatWoot system. It allows users to query contacts by various identifiers such as name, email, phone number, or a general search string. This is useful for workflows that need to retrieve contact information dynamically based on user input or other triggers, for example, to look up customer details before sending messages or updating records.
Practical examples:
- Searching for a contact by their email address to fetch their profile data.
- Retrieving a paginated list of contacts sorted by last activity date to prioritize recent interactions.
- Filtering contacts by phone number to integrate with telephony systems.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account to which the contacts belong. This is required to scope the search. |
| Q | A search string used to find contacts by matching their name, identifier, email, or phone number. |
| Sort | Attribute to sort the results by. Options include: Name, Email, Phone Number, Last Activity At. Each can be sorted ascending or descending (indicated by a leading -). |
| Page | The page number of the paginated results to retrieve. Defaults to 1. |
Output
The node outputs JSON data representing the search results of contacts. The structure typically includes an array of contact objects containing fields such as name, email, phone number, and last activity timestamp. This output can be used downstream in the workflow for further processing, filtering, or integration.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- Needs the base URL of the ChatWoot instance configured in the credentials.
- Relies on the ChatWoot REST API endpoint for contacts search.
Troubleshooting
Common issues:
- Invalid or missing account ID will cause the search to fail or return no results.
- Incorrect API credentials or base URL configuration will result in authentication errors.
- Providing an invalid page number or unsupported sort option may lead to API errors or empty responses.
Error messages:
- Authentication failures usually indicate misconfigured API keys or URLs; verify credentials.
- Validation errors related to parameters suggest checking that required fields like Account Id are set and correctly formatted.
- Network or timeout errors imply connectivity issues with the ChatWoot server.
Links and References
- ChatWoot API Documentation — Official API docs for reference on endpoints and parameters.
- n8n Documentation — For guidance on setting up credentials and using nodes effectively.