Omniwallet - Get Customers ToolInstall

Summary

Retrieve customer records from Omniwallet, supporting pagination, filtering by creation date, and sorting.

Inputs

• Page Size — The maximum number of customer records to retrieve per page, between 1 and 100.
• Page Number — The specific page number of results to retrieve.
• Filter by Created At — Filters customers to include only those created on or after the specified date, in 'YYYY-MM-DD' or 'YYYY-MM-DDTHH:mm:ss' format.
• Sort By — Sorts the retrieved customer records by a chosen field such as 'Created At', 'Email', 'Last Name', 'Name', 'Points', or 'Updated At'.
• Sort Order — Sets the sorting direction (ascending or descending) if a 'Sort By' field is specified.

Output shape

a list of customer records

Each output item contains a 'json' property with a customer record object. If the API response wraps the list under a 'data' key, it will be unwrapped; otherwise, the full response body is returned.

Examples

Example 1: Retrieve the first 25 customer records.

Set 'Page Size' to 25.

Example 2: Get customer records created in 2023, sorted by email in ascending order.

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

Example 3: Retrieve the third page of customer records, with 10 records per page.

Set 'Page Size' to 10 and 'Page Number' to 3.