On this page

    1. Home
    2. API
    3. API Reference
    4. Account
    5. Account Referral Code

    Account Referral Code

    This endpoint retrieves the unique referral code assigned to your network. You can share this code with others to earn rewards when they join the URnetwork.


    GET /account/referral-code

    Fetches your referral code and the total number of users who have signed up using it.

    Request

    GET /account/referral-code

    Headers:

    {
      "Host": "api.bringyour.com",
      "Authorization": "Bearer YOUR_JWT_TOKEN",
      "Accept": "application/json"
    }

    Response

    200 Success

    Status: 200 OK

    Content-Type: application/json

    {
      "referral_code": "string",
      "total_referrals": 0
    }

    Fields

    FieldTypeDescription
    referral_codestringYour network's unique referral UDID.
    total_referralsintegerThe total number of successful referrals credited to your account.

    Example

    HTTP Request

    GET /account/referral-code HTTP/1.1
    Host: api.bringyour.com
    Authorization: Bearer YOUR_JWT_TOKEN
    Accept: application/json

    Successful HTTP Response

    {
      "referral_code": "c73040c1-8888-4444-aaaa-000000000000",
      "total_referrals": 12
    }


    Powered by Sudoc v2.5.0
    Hide table of contents