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
- Webhooks Actions
- Teams Actions
- Custom Filters Actions
- Reports Actions
Overview
The node interacts with the ChatWoot API to filter contacts based on specified criteria. It allows users to query contacts within a particular account by applying multiple attribute-based filters combined with logical operators. This is useful for segmenting contacts, targeting specific groups for messaging campaigns, or extracting subsets of contact data for analysis.
For example, you could use this node to retrieve all contacts in an account whose name equals "en" and whose country code equals "us". This helps in narrowing down large contact lists to relevant entries matching your conditions.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account from which to filter contacts. |
| Page | The page number of results to retrieve (for pagination). |
| Payload | A JSON array defining filter conditions. Each condition includes: |
- attribute_key: The contact attribute to filter on (e.g., "name", "country_code"). |
|
- filter_operator: The comparison operator (e.g., "equal_to"). |
|
- values: An array of values to match against the attribute. |
|
- query_operator: Logical operator ("AND"/"OR") to combine this filter with others. |
Output
The node outputs JSON data representing the filtered list of contacts returned by the ChatWoot API. The structure typically includes contact details matching the filter criteria. If pagination is used, the output may include metadata about pages and total counts.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- The base URL for the ChatWoot instance must be configured in the credentials.
- The node uses HTTP requests to communicate with the ChatWoot REST API.
Troubleshooting
- Invalid Account Id: Ensure the provided account ID exists and is accessible with the API key.
- Malformed Payload: The payload must be valid JSON and follow the expected filter format; otherwise, the API may reject the request.
- Pagination Issues: If no results appear, verify the page number is within the available range.
- Authentication Errors: Check that the API key and base URL are correctly set in credentials.
- API Rate Limits: Excessive requests may lead to rate limiting; handle retries accordingly.
Links and References
- ChatWoot API Documentation – Official API reference for endpoints and filtering options.
- n8n Documentation – General guidance on using credentials and HTTP request nodes.