v7
latestOpenAPI 3.0.02026-08-08811,0051.1 MBReturns a list of customers with their points balance, points to expire and point history.
This endpoint returns detailed customer information including:
- Basic customer data (name, email, phone, document)
- Points balance and cashback balance
- List of points that will expire soon
- Complete point transaction history with branch information
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 10000 items per request.
Query parameters
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: 10000)
Response
Paginated list of customers with points data