Energy Solutions Backend API
Server v1.0.0 | API v1 | unknown
📚 API Documentation

🔧 Swagger UI

Interactive API documentation with testing capabilities

📖 Redoc

Beautiful, responsive API documentation

📄 OpenAPI Spec

Raw OpenAPI 3.0 specification in JSON format

🏷️ Version Info

Complete server and API version information
🚀 Available Endpoints
393 Total Endpoints
42 Categories
v1 API Version
182 GET Endpoints
137 POST Endpoints

Admin-migrations (2 endpoints)

POST /api/v1/admin-migrations/add-deleted-at-column
POST /api/v1/admin-migrations/run-notification-migrations

Admin (26 endpoints)

GET /api/v1/admin/activity
GET /api/v1/admin/alerts
GET /api/v1/admin/analytics
GET /api/v1/admin/auth-methods
GET /api/v1/admin/contacts
GET /api/v1/admin/dashboard
GET /api/v1/admin/dashboard/stats
GET /api/v1/admin/email-worker/queue
GET /api/v1/admin/email-worker/status
GET /api/v1/admin/performance
GET /api/v1/admin/sessions
GET /api/v1/admin/socket/metrics
GET /api/v1/admin/system/health
GET /api/v1/admin/user-dashboard/stats
GET /api/v1/admin/users
GET /api/v1/admin/users/:id
POST /api/v1/admin/actions/:action
POST /api/v1/admin/email-worker/clear-failed
POST /api/v1/admin/email-worker/retry/:id
POST /api/v1/admin/sessions/:sessionId/lock
POST /api/v1/admin/sessions/:sessionId/terminate
POST /api/v1/admin/sessions/:sessionId/unlock
POST /api/v1/admin/sessions/cleanup
POST /api/v1/admin/sessions/terminate-all
PATCH /api/v1/admin/contacts/:id
PATCH /api/v1/admin/users/:id/status

Analytics (6 endpoints)

GET /api/v1/analytics/charts
GET /api/v1/analytics/dashboard-stats
GET /api/v1/analytics/devices
GET /api/v1/analytics/kpis
GET /api/v1/analytics/pages
GET /api/v1/analytics/sources

Authentication (6 endpoints)

POST /api/v1/auth/login
POST /api/v1/auth/logout
POST /api/v1/auth/refresh
POST /api/v1/auth/register
POST /api/v1/auth/register-with-invite
POST /api/v1/auth/validate-invite

Backgroundjobs (7 endpoints)

GET /api/v1/backgroundjobs/
GET /api/v1/backgroundjobs/:id
GET /api/v1/backgroundjobs/logs
GET /api/v1/backgroundjobs/logs/stats
GET /api/v1/backgroundjobs/stats
POST /api/v1/backgroundjobs/
POST /api/v1/backgroundjobs/:id/cancel

Client-power-entries (6 endpoints)

GET /api/v1/client-power-entries/
GET /api/v1/client-power-entries/:id
GET /api/v1/client-power-entries/client/:clientId
POST /api/v1/client-power-entries/
PUT /api/v1/client-power-entries/:id
DELETE /api/v1/client-power-entries/:id

Clients (7 endpoints)

GET /api/v1/clients/
GET /api/v1/clients/:id
GET /api/v1/clients/stats
GET /api/v1/clients/types/list
POST /api/v1/clients/
PUT /api/v1/clients/:id
DELETE /api/v1/clients/:id

Contact (6 endpoints)

GET /api/v1/contact/
GET /api/v1/contact/:id
POST /api/v1/contact/submit
POST /api/v1/contact/track-action
PATCH /api/v1/contact/:id/status
PUT /api/v1/contact/:id

Contacts (6 endpoints)

GET /api/v1/contacts/
GET /api/v1/contacts/:id
GET /api/v1/contacts/stats/summary
POST /api/v1/contacts/
PUT /api/v1/contacts/:id
DELETE /api/v1/contacts/:id

Contracts (17 endpoints)

GET /api/v1/contracts/
GET /api/v1/contracts/:id
GET /api/v1/contracts/:id/attachments
GET /api/v1/contracts/:id/comments
GET /api/v1/contracts/attachment-types/list
GET /api/v1/contracts/my-contracts
GET /api/v1/contracts/stats
POST /api/v1/contracts/
POST /api/v1/contracts/:id/attachments
POST /api/v1/contracts/:id/attachments/upload
POST /api/v1/contracts/:id/comments
PUT /api/v1/contracts/:contractId/attachments/:attachmentId
PUT /api/v1/contracts/:contractId/comments/:commentId
PUT /api/v1/contracts/:id
DELETE /api/v1/contracts/:contractId/attachments/:attachmentId
DELETE /api/v1/contracts/:contractId/comments/:commentId
DELETE /api/v1/contracts/:id

CRM (10 endpoints)

GET /api/v1/crm/communications
GET /api/v1/crm/contacts/recent
GET /api/v1/crm/customers
GET /api/v1/crm/dashboard
GET /api/v1/crm/leads/recent
GET /api/v1/crm/pipeline
GET /api/v1/crm/projects
GET /api/v1/crm/stats
POST /api/v1/crm/communications
POST /api/v1/crm/customers

Documents (16 endpoints)

GET /api/v1/documents/
GET /api/v1/documents/:id
GET /api/v1/documents/:id/download
GET /api/v1/documents/:id/permissions
GET /api/v1/documents/:id/team-permissions
GET /api/v1/documents/trash/list
GET /api/v1/documents/user/:userId
POST /api/v1/documents/
POST /api/v1/documents/:id/permissions
POST /api/v1/documents/:id/restore
POST /api/v1/documents/:id/team-permissions
PUT /api/v1/documents/:id
DELETE /api/v1/documents/:id
DELETE /api/v1/documents/:id/permanent
DELETE /api/v1/documents/:id/permissions/:permissionId
DELETE /api/v1/documents/:id/team-permissions/:permissionId

Email (5 endpoints)

POST /api/v1/email/forgot-password
POST /api/v1/email/reset-password
POST /api/v1/email/send-custom
POST /api/v1/email/send-verification
POST /api/v1/email/verify

Email Queue (9 endpoints)

GET /api/v1/emailqueue/emails
GET /api/v1/emailqueue/emails/:id
GET /api/v1/emailqueue/status
GET /api/v1/emailqueue/worker/status
POST /api/v1/emailqueue/cleanup
POST /api/v1/emailqueue/emails/:id/cancel
POST /api/v1/emailqueue/emails/:id/retry
POST /api/v1/emailqueue/worker/start
POST /api/v1/emailqueue/worker/stop

Emailtemplates (7 endpoints)

GET /api/v1/emailtemplates/
GET /api/v1/emailtemplates/:id
GET /api/v1/emailtemplates/slug/:slug
POST /api/v1/emailtemplates/
POST /api/v1/emailtemplates/:id/preview
PUT /api/v1/emailtemplates/:id
DELETE /api/v1/emailtemplates/:id

Enhanced Auth (20 endpoints)

GET /api/v1/enhancedauth/biometric/devices
GET /api/v1/enhancedauth/me
GET /api/v1/enhancedauth/methods
GET /api/v1/enhancedauth/profile
GET /api/v1/enhancedauth/settings
POST /api/v1/enhancedauth/biometric/login
POST /api/v1/enhancedauth/biometric/login/options
POST /api/v1/enhancedauth/biometric/register
POST /api/v1/enhancedauth/biometric/register/options
POST /api/v1/enhancedauth/biometric/unlock
POST /api/v1/enhancedauth/biometric/unlock/options
POST /api/v1/enhancedauth/pin/create
POST /api/v1/enhancedauth/pin/login
POST /api/v1/enhancedauth/pin/verify
PUT /api/v1/enhancedauth/pin/update
PUT /api/v1/enhancedauth/profile
PUT /api/v1/enhancedauth/settings
DELETE /api/v1/enhancedauth/biometric/devices/:id
DELETE /api/v1/enhancedauth/biometric/remove
DELETE /api/v1/enhancedauth/pin/remove

Folders (9 endpoints)

GET /api/v1/folders/
GET /api/v1/folders/:id
GET /api/v1/folders/:id/permissions
GET /api/v1/folders/search
POST /api/v1/folders/
POST /api/v1/folders/:id/permissions
PUT /api/v1/folders/:id
DELETE /api/v1/folders/:id
DELETE /api/v1/folders/:id/permissions/:permissionId

Jobs (7 endpoints)

GET /api/v1/jobs/
GET /api/v1/jobs/:jobId
GET /api/v1/jobs/stats
POST /api/v1/jobs/
POST /api/v1/jobs/:jobId/cancel
POST /api/v1/jobs/:jobId/retry
DELETE /api/v1/jobs/:jobId

Leads (7 endpoints)

GET /api/v1/leads/
GET /api/v1/leads/:id
GET /api/v1/leads/pipeline
GET /api/v1/leads/stats
POST /api/v1/leads/
PUT /api/v1/leads/:id
DELETE /api/v1/leads/:id

Logs (3 endpoints)

GET /api/v1/logs/
GET /api/v1/logs/socket
GET /api/v1/logs/system

Notification-templates (8 endpoints)

GET /api/v1/notification-templates/
GET /api/v1/notification-templates/:id
GET /api/v1/notification-templates/deleted
POST /api/v1/notification-templates/
POST /api/v1/notification-templates/:id/render
POST /api/v1/notification-templates/:id/restore
PUT /api/v1/notification-templates/:id
DELETE /api/v1/notification-templates/:id

Notifications (15 endpoints)

GET /api/v1/notifications/
GET /api/v1/notifications/:id/analytics
GET /api/v1/notifications/admin/analytics
GET /api/v1/notifications/admin/scheduled
GET /api/v1/notifications/analytics/summary
GET /api/v1/notifications/categories
GET /api/v1/notifications/unread-count
POST /api/v1/notifications/:id/track
POST /api/v1/notifications/admin/send
POST /api/v1/notifications/schedule
POST /api/v1/notifications/schedule/:id/cancel
POST /api/v1/notifications/test
PATCH /api/v1/notifications/:id/read
PATCH /api/v1/notifications/read-all
DELETE /api/v1/notifications/clear

Oauth (4 endpoints)

GET /api/v1/oauth/providers
POST /api/v1/oauth/apple
POST /api/v1/oauth/google
POST /api/v1/oauth/link/:provider

Profile (7 endpoints)

GET /api/v1/profile/
GET /api/v1/profile/sessions
POST /api/v1/profile/avatar
PATCH /api/v1/profile/
PATCH /api/v1/profile/password
DELETE /api/v1/profile/sessions
DELETE /api/v1/profile/sessions/:id

Projects (6 endpoints)

GET /api/v1/projects/
GET /api/v1/projects/:id
GET /api/v1/projects/stats
POST /api/v1/projects/
PUT /api/v1/projects/:id
DELETE /api/v1/projects/:id

Push-management (23 endpoints)

GET /api/v1/push-management/debug-all-subscriptions
GET /api/v1/push-management/debug-subscription/:id
GET /api/v1/push-management/mobile/devices
GET /api/v1/push-management/notifications
GET /api/v1/push-management/notifications/recent
GET /api/v1/push-management/stats
GET /api/v1/push-management/subscriptions
GET /api/v1/push-management/subscriptions/all
GET /api/v1/push-management/vapid-key
POST /api/v1/push-management/cleanup-all-subscriptions
POST /api/v1/push-management/cleanup-broken-subscriptions
POST /api/v1/push-management/fcm-subscribe
POST /api/v1/push-management/mobile/register
POST /api/v1/push-management/mobile/test/:deviceId
POST /api/v1/push-management/send
POST /api/v1/push-management/send-from-template
POST /api/v1/push-management/subscribe
POST /api/v1/push-management/subscriptions/:id/toggle
POST /api/v1/push-management/test
POST /api/v1/push-management/test-fcm
POST /api/v1/push-management/test-subscription
PUT /api/v1/push-management/mobile/settings/:deviceId
DELETE /api/v1/push-management/subscriptions/:id

Push Notifications (21 endpoints)

GET /api/v1/push/debug
GET /api/v1/push/stats
GET /api/v1/push/subscription/status
GET /api/v1/push/subscriptions
GET /api/v1/push/users
POST /api/v1/push/send/admin
POST /api/v1/push/send/admin/fcm
POST /api/v1/push/send/announcement
POST /api/v1/push/send/announcement/fcm
POST /api/v1/push/send/announcement/fcm
POST /api/v1/push/send/custom
POST /api/v1/push/send/energy-alert
POST /api/v1/push/send/new-lead
POST /api/v1/push/send/user
POST /api/v1/push/send/user/fcm
POST /api/v1/push/subscribe
POST /api/v1/push/subscribe/fcm
POST /api/v1/push/test
POST /api/v1/push/test/fcm
POST /api/v1/push/unsubscribe
POST /api/v1/push/unsubscribe/fcm

Rbac-demo (8 endpoints)

GET /api/v1/rbac-demo/admin-only
GET /api/v1/rbac-demo/high-level-role
GET /api/v1/rbac-demo/manager-or-admin
GET /api/v1/rbac-demo/permissions
GET /api/v1/rbac-demo/profile/:userId
GET /api/v1/rbac-demo/test-all
GET /api/v1/rbac-demo/user-management
POST /api/v1/rbac-demo/custom-check

Rbac-management (30 endpoints)

GET /api/v1/rbac-management/invitations/pending
GET /api/v1/rbac-management/overview
GET /api/v1/rbac-management/permissions
GET /api/v1/rbac-management/roles
GET /api/v1/rbac-management/roles/:roleId/permissions
GET /api/v1/rbac-management/roles/:roleId/permissions
GET /api/v1/rbac-management/users
GET /api/v1/rbac-management/users/:id/permissions
POST /api/v1/rbac-management/invitations/:id/resend
POST /api/v1/rbac-management/permissions
POST /api/v1/rbac-management/roles
POST /api/v1/rbac-management/roles
POST /api/v1/rbac-management/roles/:roleId/permissions
POST /api/v1/rbac-management/roles/:roleId/permissions/:permissionId
POST /api/v1/rbac-management/users
POST /api/v1/rbac-management/users/:id/change-password
POST /api/v1/rbac-management/users/:id/permissions
POST /api/v1/rbac-management/users/:id/resend-verification
POST /api/v1/rbac-management/users/invite
PATCH /api/v1/rbac-management/permissions/:id
PUT /api/v1/rbac-management/permissions/:id
PUT /api/v1/rbac-management/roles/:id
PUT /api/v1/rbac-management/users/:id
PUT /api/v1/rbac-management/users/:id/role
DELETE /api/v1/rbac-management/invitations/:id
DELETE /api/v1/rbac-management/roles/:id
DELETE /api/v1/rbac-management/roles/:roleId/permissions/:permissionId
DELETE /api/v1/rbac-management/roles/:roleId/permissions/:permissionId
DELETE /api/v1/rbac-management/users/:id
DELETE /api/v1/rbac-management/users/:id/permissions

Reports (8 endpoints)

GET /api/v1/reports/recent
GET /api/v1/reports/scheduled
POST /api/v1/reports/custom
POST /api/v1/reports/generate
POST /api/v1/reports/schedule
PUT /api/v1/reports/schedule/:id
DELETE /api/v1/reports/:id
DELETE /api/v1/reports/schedule/:id

Security (8 endpoints)

GET /api/v1/security/alerts
GET /api/v1/security/dashboard
GET /api/v1/security/events
GET /api/v1/security/metrics
GET /api/v1/security/settings
GET /api/v1/security/stats
POST /api/v1/security/alerts/:alertId/resolve
PUT /api/v1/security/settings

Session Management (4 endpoints)

GET /api/v1/session/status
POST /api/v1/session/activity
POST /api/v1/session/lock
POST /api/v1/session/unlock

Settings (7 endpoints)

GET /api/v1/settings/
GET /api/v1/settings/backups
GET /api/v1/settings/system-status
POST /api/v1/settings/backup
POST /api/v1/settings/restore/:backupId
POST /api/v1/settings/test-email
PUT /api/v1/settings/

Suppliers (5 endpoints)

GET /api/v1/suppliers/
GET /api/v1/suppliers/:id
POST /api/v1/suppliers/
PUT /api/v1/suppliers/:id
DELETE /api/v1/suppliers/:id

Support (6 endpoints)

GET /api/v1/support/stats
GET /api/v1/support/tickets
GET /api/v1/support/tickets/:id
POST /api/v1/support/tickets
POST /api/v1/support/tickets/:id/responses
PUT /api/v1/support/tickets/:id

System-logs (4 endpoints)

GET /api/v1/system-logs/logs
GET /api/v1/system-logs/logs/stats
POST /api/v1/system-logs/logs/export
DELETE /api/v1/system-logs/logs/cleanup

Teams (10 endpoints)

GET /api/v1/teams/
GET /api/v1/teams/:id
POST /api/v1/teams/
POST /api/v1/teams/:id/members
POST /api/v1/teams/:id/permissions
PUT /api/v1/teams/:id
PUT /api/v1/teams/:id/members/:memberId
DELETE /api/v1/teams/:id
DELETE /api/v1/teams/:id/members/:memberId
DELETE /api/v1/teams/:id/permissions/:permissionId

Test-logging (6 endpoints)

GET /api/v1/test-logging/error
GET /api/v1/test-logging/firebase-debug
GET /api/v1/test-logging/info
GET /api/v1/test-logging/performance
GET /api/v1/test-logging/request-info
POST /api/v1/test-logging/security

Twofactor (5 endpoints)

GET /api/v1/twofactor/status
POST /api/v1/twofactor/disable
POST /api/v1/twofactor/enable
POST /api/v1/twofactor/setup
POST /api/v1/twofactor/verify

Worker (11 endpoints)

GET /api/v1/worker/config
GET /api/v1/worker/health
GET /api/v1/worker/jobs
GET /api/v1/worker/logs
GET /api/v1/worker/stats/connections
GET /api/v1/worker/stats/logs
GET /api/v1/worker/stats/summary
GET /api/v1/worker/stats/users
POST /api/v1/worker/health/check
POST /api/v1/worker/jobs
DELETE /api/v1/worker/jobs/:id

System (12 endpoints)

GET /
GET /api
GET /api/test
GET /api/versions
GET /database/stats
GET /dependencies
GET /dependencies/key
GET /dependencies/outdated
GET /dependencies/security
GET /health
GET /version
GET /version/summary

Documentation (3 endpoints)

GET /api-docs
GET /api-docs.json
GET /redoc
API Server is running | Uptime: 21h 34m 45s | Environment: development

Built with Express.js, JWT Authentication, and comprehensive API documentation

Branch: unknown | Commit: unknown | Node.js v22.15.0