Get Tenant Dashboard
GET /tenant/{tenantId}/dashboard
Path Parameters
The unique identifier of the tenant
Response
Returns a rendered HTML view with the following data structure:
Core tenant information
Tenant subdomain (e.g., “mystore”)
Tenant status: active or frozen
Business slogan or tagline
WhatsApp number for sales
WhatsApp number for support
Current open/closed status
Associated plan ID (1=Oportunidad, 2=Crecimiento, 3=Visión)
JSON configuration object containing engine settings, business info, currency display, and more
Subscription plan details
Plan name (e.g., “OPORTUNIDAD”, “CRECIMIENTO”, “VISIÓN”)
Visual customization settings
Active Preline theme slug (e.g., “default”, “slate”, “zinc”, “custom”)
Hero section main image filename
Hero layout type (e.g., “gradient”, “image”)
Promotional header message (Plan 2+)
Section-specific content (titles, subtitles, eyebrows)
About section text content
Configured payment methods (global and per-branch for Plan 3)
Social media URLs (1 network for Plan 1, unlimited for Plan 2+)
Contains sections_order array for section visibility and ordering
Array of products ordered by position and featured status
Badge type: hot, new, or promo
Product visibility status
Main product image filename
Array of services ordered by position
Tabler icon name (e.g., “tabler—rocket”)
Service image filename (alternative to icon)
Service visibility status
Array of physical branches (Plan 3 only, max 3)
Current USD to Bs exchange rate
Current EUR to Bs exchange rate
Days remaining until plan expires
True if plan expires within 7 days
True if tenant is frozen due to expired subscription
Template type: synticat, food, or studio
Base64 QR code for traffic tracking (300x300)
Short URL for traffic tracking
Status Codes
200 - Success: Returns dashboard view404 - Tenant not found500 - Server error
Example Usage
fetch('/tenant/123/dashboard', {
method: 'GET',
credentials: 'include'
})
.then(response => {
// Returns rendered HTML dashboard
})
Error Handling
If the tenant is not found or has an invalid status, the endpoint returns an HTTP 500 error with a rendered error page.
{
"exception": "Error message details"
}