This endpoint returns detailed customer information including:
By default, only active (enrolled) customers are returned. Use isEnrolled=false to get inactive customers.
You can filter customers by point event date using pointDateFrom and pointDateTo parameters. When these filters are used, only customers who have points within the specified date range will be returned.
Performance Note: Due to the detailed data returned, pageSize is limited to 500 items per request.
Use API Basic Auth Keys
Optional start date for filtering customers by creation date
Optional end date for filtering customers by creation date
Optional filter by customer document (CPF/CNPJ)
Optional filter by customer email
Optional filter by customer original ID (store ID)
Filter by enrolled status (default: true - only active customers)
Optional start date for filtering customers by point event date
Optional end date for filtering customers by point event date
Page number for pagination (default: 1)
Number of items per page (default: 10, max: 500)
Paginated list of customers with points data
Base List response model methods
Collection with the found entities on the bonifiq DB.
Total of rewards Configurations founds.
Pagination size
Actual Page Number
true if there is another page to be load.
If true the request had an error.
List with the error messages