Actions21
Overview
This node interacts with the Easy!Appointments API to manage customer data. Specifically, the "Get Many" operation for the "Customer" resource retrieves multiple customer records from the system. It supports fetching either all customers or a limited number of them, with options to filter, sort, and include related data.
Common scenarios where this node is beneficial include:
- Synchronizing customer lists from Easy!Appointments into other systems.
- Generating reports or analytics based on customer data.
- Filtering customers by search terms or sorting them for display purposes.
For example, you might use this node to fetch all customers who match a certain search query or to retrieve a sorted list of customers including related appointment data.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all customer records or only up to a specified limit. |
| Limit | The maximum number of customer records to return (used if Return All is false). |
| Additional Fields | Collection of optional parameters to customize the response: |
| - Fields | Comma-separated list of specific customer fields to include in the response. |
| - Include Related | Comma-separated list of related data to include (e.g., appointments linked to customers). |
| - Sort | Field name to sort results by; prefix with "-" for descending order. |
| - Search Query | A search term to filter customers by matching text. |
Output
The output is a JSON array where each item represents a customer record retrieved from Easy!Appointments. Each JSON object contains customer properties as returned by the API, potentially filtered or expanded according to the input parameters.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential configured in n8n to authenticate requests to the Easy!Appointments API.
- The base URL for the API must be set in the credentials configuration.
- Relies on internal helper functions to perform HTTP requests and handle pagination when returning many records.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Providing invalid field names in the "Fields" parameter may result in incomplete or empty responses.
- Using an invalid format in the "Include Related" or "Sort" fields could lead to API errors.
Error messages:
- Authentication errors typically indicate problems with the API key or base URL setup.
- JSON parsing errors may occur if the API returns unexpected data formats.
- If the node throws errors about invalid parameters, verify that all input fields conform to expected types and formats.
To resolve these issues, ensure your API credentials are correct, double-check the spelling and formatting of optional parameters, and consult the Easy!Appointments API documentation for valid field names and query options.
Links and References
- Easy!Appointments API Documentation (for detailed API usage and available fields)
- n8n Documentation on Creating Custom Nodes