Overview
This node, named "Omniwallet - Get Customers Tool," is designed to retrieve customer data from the Omniwallet API. It supports pagination, filtering by creation date, and sorting of the customer list. This node is useful in scenarios where you need to fetch and process customer information from Omniwallet for reporting, analytics, or integration with other systems.
Practical examples include:
- Fetching a specific page of customers to display in a dashboard.
- Filtering customers created after a certain date to target recent sign-ups.
- Sorting customers by email or name to organize data before further processing.
Properties
| Name | Meaning |
|---|---|
| Page Size | Number of items per page (minimum 1, maximum 100). |
| Page Number | Page number to retrieve (minimum 1). |
| Filter by Created At | Filter customers by their creation date. Accepts date strings in YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss format. |
| Sort By | Field to sort customers by. Options: Created At, Email, Last Name, Name, Updated At, or None (no sorting). |
| Sort Order | Sort order direction when sorting is applied. Options: Ascending or Descending. |
Output
The node outputs an array of JSON objects under the json field. Each object corresponds to a customer record retrieved from the Omniwallet API. The structure of each customer object matches the API's response schema and is accessible via the data property in the response.
If an error occurs during retrieval for a particular item and the node is set to continue on failure, the output will contain an error object with the error message, the index of the item that caused the error, and the parameters used for that request.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating requests to the Omniwallet API.
- The node uses an internal helper function to make HTTP GET requests to the Omniwallet API endpoint
/customers. - No additional external dependencies are required beyond the configured API credentials.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Providing invalid date formats in the "Filter by Created At" property may result in no data returned or API errors.
- Requesting page numbers or sizes outside allowed ranges may lead to empty results or errors.
Error messages:
- Errors thrown by the API or network issues will be surfaced as error messages in the node output if "Continue On Fail" is enabled.
- Typical error messages include authentication failures, invalid query parameters, or rate limiting responses.
Resolution tips:
- Ensure the API key credential is correctly configured and has necessary permissions.
- Validate date filters conform to expected ISO date/time formats.
- Adjust pagination parameters within allowed limits.
Links and References
- Omniwallet API Documentation (Assumed URL for reference purposes)