Custom Reward

Get CustomRewards of an entity

get

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

400

Client error

application/json

401

Unauthorized error

application/json

500

Server error

application/json

get

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "data": {
    "userId": "text",
    "rewardId": "text",
    "entityId": "text",
    "createdAt": "2025-06-05T23:02:57.010Z"
  }
}

Add custom reward to user

post

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

400

Client error

application/json

401

Unauthorized error

application/json

500

Server error

application/json

post

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "data": {
    "userId": "text",
    "rewardId": "text",
    "entityId": "text",
    "createdAt": "2025-06-05T23:02:57.010Z"
  }
}