Actions36
- Account Actions
- Canned Response Actions
- Contact Actions
- Conversation Actions
- Inbox Actions
- Label Actions
- Message Actions
- Team Actions
- Webhook Actions
Overview
This node interacts with the Chatwoot API to manage contacts and other resources. Specifically, the "Contact - Get Many" operation retrieves multiple contact records from a Chatwoot account. It supports pagination and sorting options, allowing users to fetch contacts in batches and order them by attributes such as name, email, phone number, or last activity date.
Common scenarios for this node include:
- Synchronizing contact lists from Chatwoot into other systems.
- Displaying or processing large sets of contacts with control over sorting and pagination.
- Automating workflows that require bulk retrieval of contact data for analysis or reporting.
Example: Fetching the first page of contacts sorted by name ascending to display in a CRM dashboard.
Properties
| Name | Meaning |
|---|---|
| Additional Options | Collection of optional parameters: |
| - Page | The page number for pagination (minimum 1). |
| - Sort | Attribute to sort the results by. Options: Email (A-Z), Email (Z-A), Last Activity (Newest), Last Activity (Oldest), Name (A-Z), Name (Z-A), Phone Number (A-Z), Phone Number (Z-A). |
| Continue on Fail | Whether to continue processing subsequent items if this operation fails (boolean). |
| Debug Logging | Whether to output detailed request and response information to the console (boolean). |
Output
The output is an array of JSON objects, each representing a contact retrieved from the Chatwoot API. Each item corresponds to one contact's data as returned by the API's /contacts endpoint under the specified account.
The structure of each contact JSON object includes all standard contact fields provided by Chatwoot, such as name, email, phone number, identifiers, custom attributes, and metadata related to the contact.
No binary data is output by this operation.
Dependencies
- Requires an API key credential for authenticating with the Chatwoot API.
- Needs the Chatwoot account ID and base URL configured in the credentials.
- The node uses HTTP requests to communicate with the Chatwoot REST API endpoints.
- No additional external dependencies beyond the Chatwoot API and n8n's HTTP helper methods.
Troubleshooting
- Invalid API Credentials: If authentication fails, ensure the API key and account ID are correctly set in the credentials.
- Pagination Issues: Requesting pages beyond available data will return empty results; verify the page number.
- Sorting Errors: Using unsupported sort values may cause API errors; use only the provided sort options.
- Network Errors: Check network connectivity and Chatwoot server availability.
- JSON Parsing Errors: Not applicable here since no JSON input parsing is required for this operation.
- Debug Logging: Enable debug logging to see detailed request URLs, headers, and responses for troubleshooting.