GambioInstall

Summary

Retrieve multiple customers from the Gambio shop using the v3 API with optional filtering, sorting, pagination, and field selection.

Inputs

• Authentication — Choose between Basic Auth (admin email and password) or Bearer Token (JWT) for authenticating with the Gambio API.
• Fields — Comma-separated list of specific customer fields to return (e.g., id,customer.firstName).
• Filter — Filtering criteria as one or more field and value pairs supporting wildcards and operators (e.g., personalInformation.firstName). Multiple filters can be applied.
• Page — Page number for paginated results; defaults to 1.
• Per Page — Number of customer records returned per page, between 1 and 100; defaults to 25.
• Sort — Comma-separated list of fields to sort by, with optional '+' for ascending or '-' for descending (e.g., -creationDate,+customer.firstName).

Output shape

a list of customer records

Returns the customers in a 'data' property of the API response. Supports pagination via page and perPage parameters. Optional filters, sorting, and limited fields can be specified for result customization.

Examples

Example 1: Retrieve the first 10 customers sorted by descending creation date.

Set 'Per Page' to 10 and 'Sort' to '-creationDate' with 'Page' 1.

Example 2: Retrieve customers with first name starting with 'A' and only return their id and firstName.

Set a filter for 'personalInformation.firstName' with value 'A*' and set 'Fields' to 'id,customer.firstName'.