v4
OpenAPI 3.0.02026-07-31811,0021.1 MBReturns earned points that can be used to track received-point events and customer notification flows.
Use this endpoint when the integration needs the list of points received by customers in a period, especially for "points available" communication and notification use cases.
This endpoint returns earned/received point entries only and depends on the tenant's points-available notification configuration. If that notification feature is disabled, the response is an empty list.
The result includes the structured Customer node, the associated Order when the point was generated from a purchase, the associated Objective when available, expiration/cashback information, and the notification date calculated from the notification cadence.
When includePurchaseDetails is true, the response includes PurchaseDetails only for purchase points that have persisted purchase calculation details. Pagination is applied before these details are loaded, so PurchaseDetails is resolved only for purchase points in the current page.
For a complete historical report of all point movements, including rewards, expirations, refunds and other non-earned point types, use ListPointsReport instead.
Query parameters
Start date for filtering points by event date.
End date for filtering points by event date. When omitted or default, DateTime.UtcNow is used.
Optional list of point types to include in the received-points result.
Page number for pagination (default: 1).
Number of items per page (default: 10, max: 10000).
When true, includes purchase point calculation details for purchase points in the returned page when available. Default is false for backward compatibility.
Response
Paginated list of received point entries for customer notification/integration workflows.