MagicStack API Help

GET

/docs/

Help docs

This page. Every route below returns { success, data } on success or { success, error: { code, message } } on failure, and (other than health checks) requires an Authorization: Bearer <jwt> header.

Core routes

GET /health
GET /db/health
GET /tenant/*
POST /payment, POST /payment/webhook

Account & profiles - docs

GET/POST/PATCH /me
GET/POST/PATCH /student-profile
GET/POST/PATCH /mentor-profile, POST /mentor-profile/availability
GET /tags, GET /tag-suggestions

Discovery & requests - docs

GET /mentors, GET /mentor-suggestions, GET /mentor/:id
GET/POST /interest-requests, GET /interest-request/:id
POST /interest-request/:id/accept|decline|request-more-info|cancel

Connections, ratings & safety - docs

GET /connections, GET /connection/:id, POST /connection/:id/end
POST/GET /ratings
POST /reports, POST /blocks, DELETE /block/:id

Dashboards & admin - docs

GET /student-dashboard, GET /mentor-dashboard
GET /admin/users, PATCH /admin/user/:id
GET /admin/reports, PATCH /admin/report/:id

GET

/health

Service health

Returns the service status and deployment timestamp. No authentication required.

Response

{
  "service": "sample",
  "status": "ok",
  "deployed_at": "unknown"
}

GET

/db/health

Database health

Verifies the API can acquire a connection from the MySQL pool and execute a query. Returns 503 if the connection fails.

Response

{
  "service": "sample",
  "status": "ok",
  "deployed_at": null,
  "message": "Database connection successful",
  "database": "your_db"
}