Custom Reward

Get CustomRewards of an entity

get
/entities/{entityId}/users/{userId}/custom-reward

This endpoint retrieves CustomReward associated with the given entity.

Path parameters
entityIdstringRequired
userIdstringRequired
Header parameters
apikeystringRequired

The API key for authentication

Example: test
useridstringRequired

The Id of the user performing the request.

Example: dummy-userid
tokenstringRequired

The token for user authentication.

Example: dummy-token
Responses
200

Successful response

application/json
get
/entities/{entityId}/users/{userId}/custom-reward
GET /api/entities/{entityId}/users/{userId}/custom-reward HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Accept: */*

{
  "success": true,
  "data": {
    "userId": "text",
    "rewardId": "text",
    "entityId": "text",
    "createdAt": "2025-10-18T06:39:39.158Z"
  }
}

Add custom reward to user

post
/entities/{entityId}/users/{userId}/{rewardId}

Add a custom reward to a user in a specific entity.

Path parameters
entityIdstringRequired
userIdstringRequired
rewardIdstringRequired
Header parameters
apikeystringRequired

The API key for authentication

Example: test
useridstringRequired

The Id of the user performing the request.

Example: dummy-userid
tokenstringRequired

The token for user authentication.

Example: dummy-token
Responses
200

Successful response

application/json
post
/entities/{entityId}/users/{userId}/{rewardId}
POST /api/entities/{entityId}/users/{userId}/{rewardId} HTTP/1.1
Host: https:/.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Accept: */*

{
  "success": true,
  "data": {
    "userId": "text",
    "rewardId": "text",
    "entityId": "text",
    "createdAt": "2025-10-18T06:39:39.158Z"
  }
}
PreviousGemNextEntity Gem

Last updated