manager
metrics
accesslists
boosts
users
- GETuser profile
- GETuser details
- PUTupdate profile
- GETETH earned by user
- PUTupdate notification preferences
- GETfarcaster profile
- GETfarcaster verification status
- POSTadd neynar connection
- DELremove neynar connection
- POSTadd twitter connection
- DELdelete twitter connection
- GETUser notifications
- POSTread notifications
- GETuser rewards
- GETprotocol rewards summary
- GETprotocol rewards earnings
- GETreferrals summary
- GETreferrals earnings
- GETreferrals feed
- GETtotal referral earnings
- GETreferrals activity feed
- GETactive/completed boosts referrals feed
inboxes
manager
metrics
accesslists
boosts
users
- GETuser profile
- GETuser details
- PUTupdate profile
- GETETH earned by user
- DELremove email record
- PUTupdate notification preferences
- POSTread notifications
- GETfarcaster profile
- GETfarcaster verification status
- POSTadd neynar connection
- DELremove neynar connection
- POSTadd twitter connection
- DELdelete twitter connection
- GETuser rewards
- GETprotocol rewards summary
- GETprotocol rewards earnings
- GETreferrals summary
- GETreferrals earnings
- GETreferrals feed
- GETtotal referral earnings
- GETreferrals activity feed
- GETactive/completed boosts referrals feed
inboxes
users
referrals summary
Get the referrals summary for a user
GET
/
users
/
referrals
/
summary
curl --request GET \
--url https://api-staging.boost.xyz/users/referrals/summary
{
"userAddress": "<string>",
"data": [
{
"questName": "<string>",
"boostId": "<string>",
"updatedAt": "<string>",
"totalEarning": "<string>",
"imagePath": "<string>",
"iconOption": "<string>"
}
]
}
Query Parameters
page number (1-indexed); defaults to 1
page size; defaults to 10
Response
200
application/json
Success
The response is of type object
.
curl --request GET \
--url https://api-staging.boost.xyz/users/referrals/summary
{
"userAddress": "<string>",
"data": [
{
"questName": "<string>",
"boostId": "<string>",
"updatedAt": "<string>",
"totalEarning": "<string>",
"imagePath": "<string>",
"iconOption": "<string>"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.