Get user's referral info

GET /v1/client/promotions/referral-info

Get user's referral info, if available.

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • data object
      Hide data attributes Show data attributes object
      • code string Required

        The referral codeAdd commentMore actions

      • total_amount_earned_as_referrer number(double) Required

        The amount earned as a referrer from the conversions of the referred users

      • total_amount_earned_as_referred number(double) Required

        The amount earned as a referred user.

      • total_referrals integer(int64) Required

        The total amount of users referred

GET /v1/client/promotions/referral-info
curl \
 --request GET 'https://api.bitlabs.ai/v1/client/promotions/referral-info' \
 --header "X-Api-Token: $API_KEY" \
 --header "X-User-Id: $API_KEY"
Response examples (200)
{
  "data": {
    "code": "GH89pT",
    "total_referrals": 50,
    "total_amount_earned_as_referred": 230.44,
    "total_amount_earned_as_referrer": 80.44
  },
  "status": "success",
  "trace_id": "2050914de1c94427"
}