Skip to main content
GET
/
rewards
/
summary
Get reward summary
curl --request GET \
  --url https://api.sprucecollective.co.uk/rewards/summary \
  --header 'Authorization: <api-key>'
{
  "current_points": 123,
  "current_streak_months": 123,
  "discount_claims_count": 123,
  "lifetime_months": 123,
  "milestones_awarded": {},
  "next_discount_bonus_at": 123,
  "next_loyalty_bonus_amount": 123,
  "next_milestone_at": 123,
  "next_referral_bonus_at": 123,
  "referral_points_awarded": 123,
  "referral_signup_points_awarded": 123,
  "referral_signups_count": 123,
  "site_id": "<string>",
  "successful_referrals_count": 123,
  "user_id": "<string>"
}

Authorizations

Authorization
string
header
required

Type "Bearer" followed by a space and JWT token.

Headers

x-site-id
string

Site ID (optional, uses header)

Response

OK

current_points
integer

Current status

current_streak_months
integer
discount_claims_count
integer

Discount rewards

lifetime_months
integer
milestones_awarded
object

Milestone status

next_discount_bonus_at
integer
next_loyalty_bonus_amount
integer

Next bonus amounts

next_milestone_at
integer
next_referral_bonus_at
integer
referral_points_awarded
integer

Points from purchases

referral_signup_points_awarded
integer

Points from signups

referral_signups_count
integer

Referral rewards

site_id
string
successful_referrals_count
integer

Referrals that led to purchases

user_id
string