Skip to content

API Overview

Base URL: http://localhost:3000/api/v1

Authentication

All protected endpoints require the Authorization header:

Authorization: Bearer <access_token>

Response Format

All responses follow this structure:

json
{
  "success": true,
  "data": { ... }
}

Errors:

json
{
  "success": false,
  "error": "Error message",
  "code": "ERROR_CODE"
}

Endpoints

MethodPathAuthDescription
POST/auth/registerNoRegister new user
POST/auth/loginNoLogin
POST/auth/refreshNoRefresh tokens
POST/auth/logoutNoLogout
POST/auth/logout-allYesLogout all sessions
POST/auth/change-passwordYesChange password
GET/auth/verifyYesVerify token
GET/users/profileYesGet profile
PUT/users/profileYesUpdate profile
GET/usersAdminList users
GET/users/:idAdminGet user
POST/usersAdminCreate user
PUT/users/:idAdminUpdate user
DELETE/users/:idAdminDelete user
POST/jobs/emailAdminAdd email job
POST/jobs/cleanupAdminAdd cleanup job
GET/jobs/:queue/:jobIdAdminGet job status
GET/jobs/:queue/statsAdminGet queue stats

Health Endpoints

PathDescription
/healthBasic health check
/health/liveKubernetes liveness
/health/readyReadiness with DB/Redis
/metricsPrometheus metrics

Released under the MIT License.