Skip to main content
GET
/
rewards
/
referrals
Get user referrals
curl --request GET \
  --url https://api.sprucecollective.co.uk/rewards/referrals \
  --header 'Authorization: <api-key>'
[
  {
    "created_at": "<string>",
    "id": "<string>",
    "is_cancelled": true,
    "is_completed": true,
    "referee_user_id": "<string>",
    "referral_code": "<string>",
    "referrer_user_id": "<string>",
    "site_id": "<string>",
    "status": "<string>",
    "updated_at": "<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

created_at
string
id
string
is_cancelled
boolean
is_completed
boolean
referee_user_id
string
referral_code
string
referrer_user_id
string
site_id
string
status
string
updated_at
string