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. Typical use cases include syncing customer records into a CRM, generating reports on customer activity, or triggering actions based on customer creation dates.

For example, you could use this node to:

  • Retrieve the first 50 customers created after a specific date.
  • Fetch customers sorted by their last name in descending order.
  • Paginate through all customers in batches of 20 per request.

Properties

Name Meaning
Page Size Number of items to retrieve per page (1 to 100).
Page Number The page number to retrieve (starting at 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 direction when sorting by a field. Options: Ascending, Descending.

Output

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

  • debug: Contains metadata about the request including:
    • Masked API key presence indicator.
    • Subdomain and version info from credentials.
    • The endpoint URL used.
    • Query parameters sent.
  • response: The raw response data returned by the Omniwallet API for the customers request.

No binary data output is produced by this node.

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 credential.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication errors.
    • Incorrectly formatted date filters may result in no data or API errors.
    • Requesting pages beyond available data returns empty results.

  • Error messages:

    • Errors thrown by the API are caught and returned in the output under error.message and error.stack.
    • If you see authentication errors, verify your API key and subdomain settings.
    • For filter or sorting issues, ensure the values conform to expected formats and allowed options.

Links and References

  • Omniwallet API documentation (not provided here; consult your API provider for details).
  • n8n documentation on creating custom nodes and using credentials.

Discussion