Omniwallet - Get Customers icon

Omniwallet - Get Customers

Retrieve customers from Omniwallet API

Omniwallet - Get Customers

AI-generated

Summary

Retrieve customer records from the Omniwallet API, with options for pagination, filtering, and sorting.

Inputs

  • pageSize — Specify the maximum number of customer records to retrieve per page (between 1 and 100). Defaults to 10.
  • pageNumber — Indicate the specific page number of customer records to retrieve. Defaults to 1.
  • filterCreatedAt — Filter customers by their creation date. Provide a date in 'YYYY-MM-DD' or 'YYYY-MM-DDTHH:mm:ss' format.
  • sort — Select a field to sort the customer records by, such as 'Created At', 'Email', 'Last Name', 'Name', 'Points', or 'Updated At'.
  • sortOrder — Choose the sort order: 'Ascending' (asc) or 'Descending' (desc). This option is only available when a 'Sort By' field is selected. Defaults to 'Ascending'.

Output shape

A single JSON object containing debug information and the API response.

The output is an array with one item. This item is an object with two keys: debug (containing internal details like endpoint and query parameters) and response. The response key holds the array of customer records returned by the Omniwallet API.

Examples

Example 1: Retrieve the first page of customers using default pagination.

Leave all fields at their default values.

Example 2: Fetch 50 customers from the second page, sorted by email in descending order.

Set 'Page Size' to 50, 'Page Number' to 2, 'Sort By' to 'Email', and 'Sort Order' to 'Descending'.

Example 3: Get customers created on a specific date, sorted by their creation date.

Set 'Filter by Created At' to '2023-10-26', 'Sort By' to 'Created At', and 'Sort Order' to 'Ascending'.

Discussion