Skip to content

Super Admin

7 endpoints in this module.

Method Path Auth Permissions Roles Description
GET /api/super-admin/stats jwt SUPER_ADMIN Get global platform statistics
GET /api/super-admin/tenants jwt SUPER_ADMIN List all tenants (paginated)
GET /api/super-admin/tenants/:id jwt SUPER_ADMIN Get tenant details by ID
POST /api/super-admin/tenants jwt SUPER_ADMIN Create a new tenant with optional initial admin user
PATCH /api/super-admin/tenants/:id/status jwt SUPER_ADMIN Update tenant status (ACTIVE, SUSPENDED, TERMINATED)
DELETE /api/super-admin/tenants/:id jwt SUPER_ADMIN Permanently delete a terminated tenant
GET /api/super-admin/tenants/:id/export jwt SUPER_ADMIN Export all tenant data (for offboarding / GDPR compliance)

Source: apps/api/src/modules/super-admin/super-admin.controller.ts