Tenant Module

Overview

Swagger-driven developer documentation for tenant endpoints and contracts.

Key APIs

Method	Path	Summary
GET	/api/tenant/profile	Get tenant profile and plan info

Frontend Usage Flow

• Frontend list pages call collection GET endpoints to load tables or summary views.

GET /api/tenant/profile

Summary: Get tenant profile and plan info

Operation ID: TenantController_getTenantProfile

Tags: Tenant

Security:

• bearer

Responses

200

Tenant profile returned successfully

Content-Type: application/json

Schema:

{
  "type": "object",
  "required": [
    "tenantId",
    "planName",
    "whitelabelEnabled"
  ],
  "properties": {
    "tenantId": {
      "type": "string"
    },
    "tenantName": {
      "type": "string"
    },
    "planName": {
      "type": "string"
    },
    "whitelabelEnabled": {
      "type": "boolean"
    }
  }
}

Example:

{
  "tenantId": "tenant-123",
  "tenantName": "Acme Industries",
  "planName": "Pro",
  "whitelabelEnabled": true
}

401

Unauthorized

No response body.

Notes / Constraints

• Swagger declares security requirements for this operation.

Module Notes / Constraints

• Generated from OpenAPI version metadata: 1.0.
• 1 operation(s) in this module declare explicit Swagger security requirements.
• HTTP methods present in this module: GET.
• This file is generated from Swagger/OpenAPI and should be regenerated when controller, DTO, or Swagger decorator changes affect the spec.