Skip to main content

Rank members by Rewards points earned since a date

GET 

/api/v2/rewards/ranking

Members of the center ordered by the Rewards points they earned from from (center local date) until now. Read-only.

  • earnedPoints adds only the points members received. Redeems and subtractions do not lower it.
  • netPoints is the balance change in the same period: earned points minus redeemed and subtracted points, plus redeems cancelled or refunded in the period. It can be higher than earnedPoints when a redeem made before from is refunded after it.
  • from can be at most 365 days in the past and not in the future, both in the center's time zone.
  • Ties are ordered by member. Members without movements since from are not listed.
  • Results are cached for up to 15 minutes.
  • Request is paginated. Max results per page: 100. Limited to 120 requests per minute per center.
  • Requires the Rewards integration permission.

Request​

Responses​

Returns the paginated ranking