Skip to content
Docs

API Reference

Alpha Learning

Enrollments, mastery, points and leaderboard. Guide: Alpha Learning.

get/alpha/curriculaget/alpha/enrollmentspost/alpha/enrollmentspatch/alpha/enrollments/{id}get/alpha/students/{id}get/alpha/students/{id}/masteryget/alpha/students/{id}/pointspost/alpha/students/{id}/pointsget/alpha/leaderboard
get/alpha/curricula

Published curricula (institution + shared)

Scope alpha:read

Parameters

  • statusquery · string
  • pagequery · integer
  • limitquery · integer
cURL
curl -X GET "https://serverless.grout.app/v1/alpha/curricula" \
  -H "Authorization: Bearer $GROUT_API_KEY"
get/alpha/enrollments

List enrollments

Scope alpha:read

Parameters

  • student_idquery · string
  • curriculum_idquery · string
  • statusquery · string
  • pagequery · integer
  • limitquery · integer
cURL
curl -X GET "https://serverless.grout.app/v1/alpha/enrollments" \
  -H "Authorization: Bearer $GROUT_API_KEY"
post/alpha/enrollments

Enroll students in a curriculum

Scope alpha:write

Body

  • curriculum_idstring
  • student_idsstring[]
  • daily_target_minutesinteger
cURL
curl -X POST "https://serverless.grout.app/v1/alpha/enrollments" \
  -H "Authorization: Bearer $GROUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"curriculum_id":"<curriculum_id>","student_ids":[],"daily_target_minutes":0}'
patch/alpha/enrollments/{id}

Update an enrollment

Scope alpha:write

Parameters

  • idpath · stringrequired

Body

  • guide_idstring|null
  • daily_target_minutesinteger
  • statusactive|paused|completed
cURL
curl -X PATCH "https://serverless.grout.app/v1/alpha/enrollments/$ID" \
  -H "Authorization: Bearer $GROUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"guide_id":"string","daily_target_minutes":0,"status":"active"}'
get/alpha/students/{id}

Student drill-down

Scope alpha:read

Parameters

  • idpath · stringrequired
cURL
curl -X GET "https://serverless.grout.app/v1/alpha/students/$ID" \
  -H "Authorization: Bearer $GROUT_API_KEY"
get/alpha/students/{id}/mastery

Concept mastery

Scope alpha:read

Parameters

  • idpath · stringrequired
cURL
curl -X GET "https://serverless.grout.app/v1/alpha/students/$ID/mastery" \
  -H "Authorization: Bearer $GROUT_API_KEY"
get/alpha/students/{id}/points

Points, streaks, badges and ledger

Scope alpha:read

Parameters

  • idpath · stringrequired
  • limitquery · integer
cURL
curl -X GET "https://serverless.grout.app/v1/alpha/students/$ID/points" \
  -H "Authorization: Bearer $GROUT_API_KEY"
post/alpha/students/{id}/points

Award bonus points (±100, idempotent by ref)

Scope alpha:write

Parameters

  • idpath · stringrequired

Body

  • pointsinteger
  • notestring
  • refstring
cURL
curl -X POST "https://serverless.grout.app/v1/alpha/students/$ID/points" \
  -H "Authorization: Bearer $GROUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"points":0,"note":"<note>","ref":"<ref>"}'
get/alpha/leaderboard

Institution leaderboard

Scope alpha:read

Parameters

  • limitquery · integer
cURL
curl -X GET "https://serverless.grout.app/v1/alpha/leaderboard" \
  -H "Authorization: Bearer $GROUT_API_KEY"