Actions17
- Contact Actions
- Message Actions
- Session Actions
- Panel Actions
Overview
This node integrates with the WTS Chat API to manage and retrieve contact data, among other resources. Specifically, for the Contact resource with the Get All Contacts operation, it fetches a paginated list of contacts from the API. This is useful in scenarios where you want to synchronize or process multiple contacts from the external system, such as importing contacts into a CRM, generating reports, or triggering workflows based on contact data.
Practical examples:
- Retrieve all contacts page by page to update your internal database.
- Sort contacts by a specific field (e.g., name or creation date) in ascending or descending order.
- Use pagination controls to limit the number of contacts processed at once, avoiding overload.
Properties
| Name | Meaning |
|---|---|
| Page Number | The page number of contacts to retrieve (default: 1). |
| Page Size | The number of contacts per page to retrieve (default: 10, min: 1, max: 100). |
| Order By | The field name by which to sort the contacts (e.g., "name", "createdAt"). |
| Order Direction | The direction of sorting: "Ascending" or "Descending". |
Output
The output is an array of JSON objects, each representing a contact retrieved from the API. Each item corresponds to one contact's data as returned by the WTS Chat API under the /core/v1/contact endpoint.
The structure of each contact JSON object depends on the API response but typically includes fields like contact ID, name, phone number, email, tags, annotations, custom fields, and metadata.
No binary data output is produced by this operation.
Dependencies
- Requires an active API key credential for authentication with the WTS Chat API.
- Makes HTTP GET requests to the base URL
https://api-test.helena.run/core/v1/contact. - Uses the Axios library for HTTP requests.
- The node expects the API key to be provided via n8n credentials configuration.
Troubleshooting
- Empty or no results: Ensure that the page number and page size are set correctly and that there are contacts available in the API.
- Invalid API key or authentication errors: Verify that the API key credential is valid and has the necessary permissions.
- Rate limiting or network errors: The API might throttle requests; consider adding delays or retries.
- Invalid "Order By" field: If sorting does not work as expected, confirm that the field name used in "Order By" matches a valid sortable field in the API.
- Page size limits: The API enforces a maximum page size of 100; setting a higher value may cause errors.
Links and References
- WTS Chat API Documentation (assumed base URL documentation)
- n8n Expressions and Parameters
- Axios HTTP Client
If you need summaries for other operations or resources, please provide their names.