Skip to main content
GET
/
api
/
v1
/
referrals
/
users
Handler to get users referred by a referrer
curl --request GET \
  --url https://api.mainnet.aptoslabs.com/decibel/api/v1/referrals/users \
  --header 'Authorization: Bearer <token>'
[
  {
    "account": "<string>",
    "is_affiliate_referral": true,
    "referral_code": "<string>",
    "referred_at_ms": 123,
    "referrer_account": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer token from Geomi. See Authentication for setup instructions.

Query Parameters

​
referrer_account
string
required

The referrer's wallet address (not a subaccount address)

​
limit
integer<int32>
default:10

Page size

Required range: 0 <= x <= 1000
​
offset
integer<int32>
default:0

Page offset

Required range: 0 <= x <= 10000

Response

Successfully retrieved user referrals

​
account
string
required

The referred user's wallet address (not a subaccount address)

​
is_affiliate_referral
boolean
required
​
referral_code
string
required
​
referred_at_ms
integer<int64>
required
​
referrer_account
string
required

The referrer's wallet address