Get Tenant Details #

Retrieve detailed information about a specific tenant.

Endpoint: GET /api/tenants/{tenantUuid}

Authentication: Required (Bearer Token)

URL Parameters:

• tenantUuid (string, UUID): The unique identifier of the tenant

Request Headers:

Content-Type: application/json
Accept: application/json
Authorization: Bearer YOUR_API_TOKEN

Success Response (200 OK):

{
  "tenant_id": "860f5708-21eb-44bf-bb4f-ce1dbed2ede1",
  "organization_name": "Agile Harbor",
  "domains": {
    "base": "dmz-tey-k83.webfluss.com",
    "custom": null,
    "subdomain": null
  }
}

Response Fields:

• tenant_id (string, UUID): The unique identifier for the tenant
• organization_name (string): The name of the organization/website
• domains (object): Domain configuration for the tenant
  • base (string|null): The base domain assigned to the tenant
  • custom (string|null): Custom domain if configured
  • subdomain (string|null): Subdomain if configured

Error Responses:

401 Unauthorized:

{
  "message": "Unauthorized"
}

404 Not Found:

{
  "message": "No query results for model [App\\Models\\Tenant] {tenant_uuid}"
}

Usage Examples #

Get Tenant Details #

curl -X GET https://webfluss.com/api/tenants/860f5708-21eb-44bf-bb4f-ce1dbed2ede1 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Example Response:

{
  "tenant_id": "860f5708-21eb-44bf-bb4f-ce1dbed2ede1",
  "organization_name": "Agile Harbor",
  "domains": {
    "base": "dmz-tey-k83.webfluss.com",
    "custom": null,
    "subdomain": null
  }
}

Domain Information #

Domain Types #

1. Base Domain: The primary domain automatically assigned to the tenant (e.g., dmz-tey-k83.webfluss.com)
2. Custom Domain: A custom domain configured by the user (e.g., example.com)
3. Subdomain: A subdomain under the main domain (e.g., mysite.webfluss.com)