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
read notifications
Retrieve paginated notifications for a user, marking them as read.
POST
/
users
/
read-notifications
curl --request POST \
--url https://api-staging.boost.xyz/users/read-notifications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"pageNo": 123,
"pageSize": 123,
"lastReadNotification": "<string>"
}'
{
"notifications": [
{
"completerAddress": "<string>",
"boostMetadata": {
"image": "<string>",
"postType": "<string>",
"profileName": "<string>"
},
"boostId": "<string>",
"completerEnsName": "<string>",
"completerEnsAvatarUrl": "<string>",
"isUnread": true,
"createdAt": "<string>",
"type": "creator-completion",
"completerRewardAmount": "<string>",
"completerRewardDecimals": 123,
"completerRewardTokenSymbol": "<string>",
"creatorEarnings": "<string>"
}
],
"page": 1,
"pageSize": 1
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200
application/json
Success
The response is of type object
.
curl --request POST \
--url https://api-staging.boost.xyz/users/read-notifications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"pageNo": 123,
"pageSize": 123,
"lastReadNotification": "<string>"
}'
{
"notifications": [
{
"completerAddress": "<string>",
"boostMetadata": {
"image": "<string>",
"postType": "<string>",
"profileName": "<string>"
},
"boostId": "<string>",
"completerEnsName": "<string>",
"completerEnsAvatarUrl": "<string>",
"isUnread": true,
"createdAt": "<string>",
"type": "creator-completion",
"completerRewardAmount": "<string>",
"completerRewardDecimals": 123,
"completerRewardTokenSymbol": "<string>",
"creatorEarnings": "<string>"
}
],
"page": 1,
"pageSize": 1
}
Assistant
Responses are generated using AI and may contain mistakes.