Skip to main content

Get Learner Settings

Authentication Required: Any authenticated user
GET /api/learner-settings/:learnerId
number
required
Learner user ID

Response

Response Example
boolean
Whether double-or-loss mode is enabled for this learner

Update Double-or-Loss Setting

Authentication Required: PARENT or ADMIN role
PUT /api/learner-settings/:learnerId/double-or-loss
number
required
Learner user ID
boolean
required
Enable or disable double-or-loss mode
Double-or-loss mode allows learners to risk their points for higher rewards on quiz questions.

Response


Activities (Legacy Rewards)

Authentication Required: Any authenticated user
GET /api/activities
Returns the list of active activities (legacy rewards catalog).

Response

Response Example

Allocate Tokens to Activities

Authentication Required: Any authenticated user
POST /api/awards/allocate
array
required
Array of allocation objects with activityId and tokens

Response

Error Codes

  • 400 - allocations must be an array
  • 400 - Not enough tokens (INSUFFICIENT_TOKENS)
  • 500 - Server error

Cash In Award

Authentication Required: Any authenticated user
POST /api/awards/:awardId/cash-in
string
required
Award ID to cash in

Response


Toggle Award Sharing

Authentication Required: Any authenticated user
POST /api/awards/:awardId/share
string
required
Award ID to share
boolean
required
Enable or disable sharing
string
Share title
string
Share description

Response


Get Public Award Share

No Authentication Required - Public endpoint
GET /users/:username/award/:hash
string
required
Username of the award owner
string
required
Unique share hash

Response

Response Example

Error Codes

  • 404 - Not found (share doesn’t exist or is not active)