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

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/custom-reward' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

200

{
  "success": true,
  "data": {
    "userId": "text",
    "rewardId": "text",
    "entityId": "text",
    "createdAt": "2025-04-03T03:53:20.206Z"
  }
}

Successful response

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

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/{rewardId}' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

200

{
  "success": true,
  "data": {
    "userId": "text",
    "rewardId": "text",
    "entityId": "text",
    "createdAt": "2025-04-03T03:53:20.206Z"
  }
}

Successful response