Omniwallet - Get Customers icon

Omniwallet - Get Customers

Retrieve customers from Omniwallet API
Join our community

Overview

This node retrieves a list of customers from the Omniwallet API. It supports pagination, filtering by creation date, and sorting by various customer fields. This functionality is useful for workflows that need to fetch customer data in batches, apply filters based on when customers were created, or order the results by specific attributes such as name or email.

Practical examples include:

  • Synchronizing customer data from Omniwallet into another system.
  • Generating reports on customers created within a certain timeframe.
  • Fetching sorted customer lists for display or 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, None.
Sort Order Sort order direction when sorting is applied. Options: Ascending, Descending.

Output

The node outputs a JSON array containing a single object with two main sections:

  • debug: Contains metadata about the request including:

    • Masked API key presence indicator.
    • Subdomain and version information from credentials.
    • The endpoint URL used for the API call.
    • Query parameters sent with the request.

  • response: The raw response data returned by the Omniwallet API for the customers request.

If an error occurs during execution, the output includes an error object with the error message and stack trace alongside the debug information.

No binary data is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Omniwallet API.
  • Uses the Omniwallet API endpoint /customers with query parameters for pagination, filtering, and sorting.
  • The node depends on a helper function (omniwalletApiRequest) to perform the HTTP GET request.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrectly formatted date strings in the "Filter by Created At" property may result in no data or errors.
    • Requesting pages beyond available data may return empty results.

  • Error messages:

    • Errors thrown by the API or network issues are caught and returned in the output under the error field.
    • The error message and stack trace can help diagnose issues such as invalid parameters or connectivity problems.

To resolve errors:

  • Verify API credentials are correctly configured.
  • Ensure date filters follow the expected format.
  • Adjust pagination parameters to valid ranges.

Links and References

  • Omniwallet API documentation (refer to the official Omniwallet API docs for details on /customers endpoint and query parameters).
  • n8n documentation on creating and using custom nodes.

Discussion