--- title: "Returns a list of customers with their points balance, points to expire and point history." method: GET path: "/v1/pvt/Reports/ListCustomersReport" tags: ["Reports"] --- # Returns a list of customers with their points balance, points to expire and point history. `GET /v1/pvt/Reports/ListCustomersReport` ## Request - Base URL: `https://api.bonifiq.com.br` - URL: `https://api.bonifiq.com.br/v1/pvt/Reports/ListCustomersReport` - Auth: HTTP basic 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. You can filter customers by their last update date using updateDateFrom and updateDateTo parameters. **Performance Note:** Due to the detailed data returned, pageSize is limited to 10000 items per request. ## Query parameters - `from` string, date-time, nullable - `to` string, date-time, nullable - `document` string, nullable - `email` string, nullable - `originalId` string, nullable - `isEnrolled` boolean - `pointDateFrom` string, date-time, nullable - `pointDateTo` string, date-time, nullable - `pageNumber` integer - `pageSize` integer - `updateDateFrom` string, date-time, nullable - `updateDateTo` string, date-time, nullable ## Response `200` Paginated list of customers with points data - BaseExternalApiListResponseOfReportCustomerResponse: Base List response model methods - `Items` object[], nullable: Collection with the found entities on the bonifiq DB. - `InternalId` string: ID for this customer on the Bonifiq DB (PublicId) - `OriginalId` string: This is the Id in the client store - `Name` string: Customer name - `Email` string, nullable: Customer email - `Phone` string, nullable: Customer Contact Phone - `Document` string, nullable: Customer document (CPF/CNPJ) - `BirthdayDate` string, date-time, nullable: Customer Birthdate - `SignupDate` string, date-time, nullable: Date when the customer made the register on client store - `IsEnrolled` boolean: If true the customer is participating on the points plan from the store - `CreatedDate` string, date-time: Date when customer was created in BonifiQ - `UpdateDate` string, date-time: Date when the customer registration data was last updated in BonifiQ. Points balance and tier changes do not update this date - `PointsBalance` integer: Amount of points for this customer - `CashbackBalance` number: When the cashback reward is active it returns the amount (in R$) of cashback the customer have. Returns 0 when the cashback is inactive - `CurrentTier` CustomerTierResponse - `Name` string - `Color` string - `IconUrl` string - `PointsToExpire` object[]: List of points that will expire soon - `Points` integer: Amount of Points - `Cashback` number, nullable: Cashback value represented by the expiring points - `When` string, date-time: Expiration Date of the points - `PointHistory` object[]: A detailed list of point transactions for the customer - `Id` integer: The unique identifier for the point transaction. - `IsCanceled` boolean: Indicates whether this history item was canceled. - `DateReceived` string, date-time: The date when the points were received or redeemed. - `ExpirationDate` string, date-time, nullable: The calculated expiration date for these points. - `Amount` integer: The amount of points in this transaction (positive for received, negative for redeemed). - `CashbackAmount` number, nullable: The amount of cashback associated with this transaction, if applicable. - `BranchId` string, nullable: The ID of the branch associated with the point transaction (if applicable, e.g., from an order). - `BranchName` string, nullable: The name of the branch associated with the point transaction (if applicable, e.g., from an order). - `OrderOrigin` 0 | 1 | 2 | 3 | 4: 0 = Integration 1 = API 2 = Import 3 = PDV 4 = OfflineIntegration - `OrderOriginDescription` string, nullable: Human-readable description for the order origin when the point comes from a purchase order. - `PointType` integer, nullable: The type of the point transaction (e.g., Purchase, Signup, Birthday, etc.). - `PointTypeDescription` string, nullable: Human-readable description of the point type. - `OrderValue` number, nullable - `OrderId` string, nullable - `Origin` 0 | 1 | 2 | 3 | 4 | 5: 0 = Platform 1 = PDV 2 = API 3 = OfflinePlatform 4 = Admin 5 = Affiliate - `TotalItemCount` integer: Total of rewards Configurations founds. - `PageSize` integer: Pagination size - `PageNumber` integer: Actual Page Number - `HasNextPage` boolean: true if there is another page to be load. - `HasError` boolean: If true the request had an error. - `ErrorMessages` string[]: List with the error messages ## Changes - **2026-10-22** `f30188727965`: 1 info - added the optional property `Items/items/oneOf[#/components/schemas/ReportCustomerResponse]/UpdateDate` to the response with the `200` status - **2026-10-21** `5b1f16130f5b`: 2 info - added the new optional `query` request parameter `updateDateFrom` - added the new optional `query` request parameter `updateDateTo` - **2026-08-29** `ce9f181d6940`: 1 info - added the optional property `Items/items/oneOf[#/components/schemas/ReportCustomerResponse]/Origin` to the response with the `200` status - **2026-07-21** `760e443ffa9b`: 2 info - added the optional property `Items/items/oneOf[#/components/schemas/ReportCustomerResponse]/PointHistory/items/oneOf[#/components/schemas/PointDetailItem]/OrderId` to the response with the `200` status - added the optional property `Items/items/oneOf[#/components/schemas/ReportCustomerResponse]/PointHistory/items/oneOf[#/components/schemas/PointDetailItem]/OrderValue` to the response with the `200` status [Operation history](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/changes/v1/pvt/Reports/ListCustomersReport/get.md) --- [API](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis.md) - [All operations](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/revisions/bac0977b23d5?raw)