Actions113
- 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
- Contacts API Actions
- Inbox API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Custom Attributes Actions
- Canned Response Actions
Overview
This node interacts with the ChatWoot API to list contacts associated with a specific account. It is useful for retrieving and managing contact information such as names, emails, phone numbers, and activity data within a ChatWoot workspace. Typical use cases include syncing contacts to a CRM, generating reports on customer interactions, or filtering contacts based on recent activity.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the ChatWoot account whose contacts you want to list (required). |
| Sort | Attribute by which the contact list should be sorted. Options: |
| - Name (ascending) | |
| - Email (ascending) | |
| - Phone Number (ascending) | |
| - Last Activity At (ascending) | |
| - Name (descending) | |
| - Email (descending) | |
| - Phone Number (descending) | |
| - Last Activity At (descending) | |
| Page | The page number of results to retrieve (pagination support). Defaults to 1. |
Output
The node outputs JSON data representing a list of contacts retrieved from the ChatWoot API. Each contact object typically includes fields such as name, email, phone number, last activity timestamp, and other relevant contact details. This structured output can be used downstream in workflows for further processing, filtering, or integration.
No binary data output is produced by this operation.
Dependencies
- Requires an active ChatWoot account and API access.
- Needs an API authentication token configured in n8n credentials to authorize requests.
- The base URL for the ChatWoot instance must be set in the credential configuration.
Troubleshooting
- Invalid Account Id: If the provided account ID does not exist or is incorrect, the API will return an error. Verify the account ID before running the node.
- Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the API key/token is correctly configured.
- Pagination Issues: Requesting pages beyond the available range may result in empty responses. Adjust the page number accordingly.
- Sorting Parameter: Using unsupported sort values might lead to unexpected results or errors. Use only the provided options.