Referrals

Referral system operations

Get user referrals

get

https://rewards.decentraland.orghttps://rewards.decentraland.zonehttp://localhost:8000

/api/referrals

Retrieve referrals made by the authenticated user

Responses

200

User referrals

application/json

okbooleanOptionalExample: true

401

Unauthorized

application/json

500

Internal server error

application/json

get/api/referrals

HTTPcURLJavaScriptPython

GET /api/referrals HTTP/1.1
Host: rewards.decentraland.org
Accept: */*

{
  "ok": true,
  "data": [
    {
      "user": "0x1234567890123456789012345678901234567890",
      "referral_of": "0x1234567890123456789012345678901234567890",
      "created_at": "2024-01-01T00:00:00Z"
    }
  ]
}

Get referral information

get

https://rewards.decentraland.orghttps://rewards.decentraland.zonehttp://localhost:8000

/api/referralOf

Get referral information for the authenticated user

Responses

200

Referral information

application/json

okbooleanOptionalExample: true

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get/api/referralOf

HTTPcURLJavaScriptPython

GET /api/referralOf HTTP/1.1
Host: rewards.decentraland.org
Accept: */*

{
  "ok": true,
  "data": {
    "user": "0x1234567890123456789012345678901234567890",
    "referral_of": "0x1234567890123456789012345678901234567890",
    "created_at": "2024-01-01T00:00:00Z"
  }
}

Create referral

post

https://rewards.decentraland.orghttps://rewards.decentraland.zonehttp://localhost:8000

/api/referralOf

Create a referral relationship for the authenticated user

Body

application/json

addressstring · addressOptional

Address of the user who made the referral

Example: 0x1234567890123456789012345678901234567890

codestringOptional

Referral code

Example: ABC123

Responses

201

Referral created successfully

application/json

okbooleanOptionalExample: true

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post/api/referralOf

HTTPcURLJavaScriptPython

POST /api/referralOf HTTP/1.1
Host: rewards.decentraland.org
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "address": "0x1234567890123456789012345678901234567890",
  "code": "ABC123"
}

{
  "ok": true,
  "data": {
    "user": "0x1234567890123456789012345678901234567890",
    "referral_of": "0x1234567890123456789012345678901234567890",
    "created_at": "2024-01-01T00:00:00Z"
  }
}