Skip to content

Endpoints

Spiros Papadimitriou edited this page Mar 23, 2026 · 1 revision

REST API Endpoints

All endpoints are mounted under /classbot/api and defined in src/api.ts.

Self (authenticated user) — requires MEMBER or ADMIN role

Method Path
GET /classbot/api/self/profile
GET /classbot/api/self/submissions
GET /classbot/api/self/org/:orgname/submissions
GET /classbot/api/self/org/:orgname/assignment/:assname/submissions
GET /classbot/api/self/alerts
GET /classbot/api/self/org/:orgname/alerts
GET /classbot/api/self/org/:orgname/assignment/:assname/alerts

User Management — requires ADMIN role

Method Path
GET /classbot/api/users
POST /classbot/api/user/create
GET /classbot/api/user/:userid/profile
PUT /classbot/api/user/:userid/profile
GET /classbot/api/user/:userid/submissions
GET /classbot/api/user/:userid/org/:orgname/submissions
GET /classbot/api/user/:userid/org/:orgname/assignment/:assname/submissions
GET /classbot/api/user/:userid/alerts
GET /classbot/api/user/:userid/org/:orgname/alerts
GET /classbot/api/user/:userid/org/:orgname/assignment/:assname/alerts

Organization Management — requires ADMIN role

Method Path
GET /classbot/api/orgs
POST /classbot/api/org/create
GET /classbot/api/org/:orgname/assignments
GET /classbot/api/org/:orgname/submissions
GET /classbot/api/org/:orgname/assignment/:assname/submissions
GET /classbot/api/org/:orgname/alerts
GET /classbot/api/org/:orgname/assignment/:assname/alerts

Clone this wiki locally