Omniwallet - Get Customers

Retrieve customers from Omniwallet API
Join our community

Overview

This node retrieves a list of customers from the Omniwallet API. It is useful for workflows that need to fetch customer data in a paginated, filtered, and sorted manner. For example, you might use this node to synchronize customer records into a CRM system, generate reports on customer activity, or trigger actions based on newly created customers.

The node supports pagination to control how many customers are retrieved per request and which page of results to fetch. It also allows filtering customers by their creation date and sorting them by various fields such as name, email, or creation date.

Properties

Name Meaning
Page Size Number of items to retrieve per page (minimum 1, maximum 100).
Page Number The page number of results to retrieve (minimum 1).
Filter by Created At Filter customers by their creation date. Accepts date strings in YYYY-MM-DD or ISO format.
Sort By Field to sort customers by. Options: Created At, Email, Last Name, Name, Updated At, None.
Sort Order Sort order direction when sorting by a field. Options: Ascending, Descending.

Output

The node outputs a JSON array containing a single object with the following structure:

  • debug: Contains metadata about the request:
    • credentials: Shows masked API key presence and other credential info (subdomain, version).
    • endpoint: The API endpoint path used including query parameters.
    • queryParams: The actual query parameters sent to the API.
  • response: The raw response data returned from the Omniwallet API containing the customers list.

If an error occurs during the API request, the output contains an error object with the error message and stack trace alongside the debug information.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Omniwallet API.
  • Uses the internal helper function omniwalletApiRequest to perform HTTP GET requests.
  • No additional environment variables are explicitly required beyond the 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 API errors or empty responses.
    • Requesting page sizes above 100 or page numbers below 1 will be rejected due to validation constraints.
  • Error messages:
    • Errors from the API are captured and returned in the output under the error field with details.
    • If the API key is invalid or expired, the node will return an authentication error.
  • Resolution tips:
    • Ensure the API key credential is correctly configured and active.
    • Use valid date formats for filtering.
    • Respect the allowed ranges for pagination properties.

Links and References

  • Omniwallet API documentation (not provided here; consult your Omniwallet API docs for detailed endpoints and parameters).

Discussion