Challenges

Time-boxed challenges — goal type, goal value, reward XP, optional reward achievement.

Challenges are time-bounded goals (start_at → end_at) that users join and make progress against. Participant progress lives in user_challenges.

Source: apps/api/src/routes/admin/challenges.ts.

Endpoints

Method	Path	Description
POST	`/admin/projects/:projectId/challenges`	Create a challenge.
GET	`/admin/projects/:projectId/challenges`	List challenges, optionally filtered by `?status=active\|upcoming\|ended`.
GET	`/admin/projects/:projectId/challenges/:challengeId`	Fetch a challenge.
PATCH	`/admin/projects/:projectId/challenges/:challengeId`	Partial update.
DELETE	`/admin/projects/:projectId/challenges/:challengeId`	Delete.
GET	`/admin/projects/:projectId/challenges/:challengeId/participants`	Paginated participants, ordered by progress.

POST /admin/projects/:projectId/challenges

Request

Field	Type	Required
`name`	string	yes
`description`	string	no
`start_at`	ISO-8601	yes
`end_at`	ISO-8601	yes
`goal_type`	string	yes
`goal_value`	number	yes
`reward_xp`	number	no (default 0)
`reward_achievement_id`	uuid	no

Response 201

{
  "data": {
    "id": "…",
    "name": "…",
    "goal_type": "workouts",
    "goal_value": 10,
    "reward_xp": 100,
    "start_at": "…",
    "end_at": "…"
  }
}

Try it:

POST/admin/projects/%7B%7BprojectId%7D%7D/challenges

developer auth

curl -X POST 'https://api.amba.dev/admin/projects/%7B%7BprojectId%7D%7D/challenges'

Loading auth… Configure auth in the settings drawer (top-right) to run this request.

Curl:

curl -X POST '${BASE_URL}/admin/projects/{projectId}/challenges' \
  -H 'Authorization: Bearer ${DEV_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET /admin/projects/:projectId/challenges

Query

Param	Values	Description
`status`	`active`, `upcoming`, `ended`	Optional filter. Omit for all.

Response 200

{
  "data": [
    { "id": "…", "name": "…", "start_at": "…", "end_at": "…", "goal_type": "…", "goal_value": 10 }
  ]
}

Try it:

GET/admin/projects/%7B%7BprojectId%7D%7D/challenges

developer auth

curl -X GET 'https://api.amba.dev/admin/projects/%7B%7BprojectId%7D%7D/challenges'

Loading auth… Configure auth in the settings drawer (top-right) to run this request.

Curl:

curl -X GET '${BASE_URL}/admin/projects/{projectId}/challenges' \
  -H 'Authorization: Bearer ${DEV_TOKEN}'

GET /admin/projects/:projectId/challenges/:challengeId

Errors

404 NOT_FOUND.

Try it:

GET/admin/projects/%7B%7BprojectId%7D%7D/challenges/%7B%7BchallengeId%7D%7D

developer auth

curl -X GET 'https://api.amba.dev/admin/projects/%7B%7BprojectId%7D%7D/challenges/%7B%7BchallengeId%7D%7D'

Loading auth… Configure auth in the settings drawer (top-right) to run this request.

Curl:

curl -X GET '${BASE_URL}/admin/projects/{projectId}/challenges/{challengeId}' \
  -H 'Authorization: Bearer ${DEV_TOKEN}'

PATCH /admin/projects/:projectId/challenges/:challengeId

Allowed fields: name, description, start_at, end_at, goal_type, goal_value, reward_xp, reward_achievement_id, is_active.

Try it:

PATCH/admin/projects/%7B%7BprojectId%7D%7D/challenges/%7B%7BchallengeId%7D%7D

developer auth

curl -X PATCH 'https://api.amba.dev/admin/projects/%7B%7BprojectId%7D%7D/challenges/%7B%7BchallengeId%7D%7D'

Loading auth… Configure auth in the settings drawer (top-right) to run this request.

Curl:

curl -X PATCH '${BASE_URL}/admin/projects/{projectId}/challenges/{challengeId}' \
  -H 'Authorization: Bearer ${DEV_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{}'

DELETE /admin/projects/:projectId/challenges/:challengeId

{ "data": { "deleted": true } }

Try it:

DELETE/admin/projects/%7B%7BprojectId%7D%7D/challenges/%7B%7BchallengeId%7D%7D

developer auth

curl -X DELETE 'https://api.amba.dev/admin/projects/%7B%7BprojectId%7D%7D/challenges/%7B%7BchallengeId%7D%7D'

Loading auth… Configure auth in the settings drawer (top-right) to run this request.

Curl:

curl -X DELETE '${BASE_URL}/admin/projects/{projectId}/challenges/{challengeId}' \
  -H 'Authorization: Bearer ${DEV_TOKEN}'

GET /admin/projects/:projectId/challenges/:challengeId/participants

Paginated list of participants, ordered by progress DESC.

Query

Param	Default
`limit`	50
`offset`	0

Response 200

{
  "data": [
    {
      "app_user_id": "…",
      "challenge_id": "…",
      "progress": 5,
      "completed_at": null,
      "app_users": { "display_name": "…", "avatar_url": "…" }
    }
  ],
  "total": 123,
  "offset": 0,
  "limit": 50
}

Try it:

GET/admin/projects/%7B%7BprojectId%7D%7D/challenges/%7B%7BchallengeId%7D%7D/participants

developer auth

curl -X GET 'https://api.amba.dev/admin/projects/%7B%7BprojectId%7D%7D/challenges/%7B%7BchallengeId%7D%7D/participants'

Loading auth… Configure auth in the settings drawer (top-right) to run this request.

Curl:

curl -X GET '${BASE_URL}/admin/projects/{projectId}/challenges/{challengeId}/participants' \
  -H 'Authorization: Bearer ${DEV_TOKEN}'

On this page