tenants
Get Tenant
Get detailed information about a specific tenant.
Purpose: Retrieve complete tenant profile and configuration
What it does:
- Returns complete tenant profile
- Shows billing, usage, and configuration details
- Displays SIP settings and compliance status
- Shows webhook configuration for integrations
Response Includes:
- Organization details (name, status, created_at)
- Billing plan and usage limits
- Feature flags (sip_enabled, recording_enabled, analytics_enabled)
- Compliance settings (hipaa_enabled, pci_enabled)
- Recording format and retention policy (retention_days)
- Webhook URL for event notifications
- Monthly usage tracking (monthly_usage_cents)
- Creation and update timestamps
Use Cases:
- Viewing customer account details
- Auditing tenant configuration
- Billing and usage review
- Support and troubleshooting
GET
Get Tenant
Documentation Index
Fetch the complete documentation index at: https://docs.mrassistant.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Successful Response
Tenant response model.
Required string length:
1 - 255Required string length:
1 - 100Required range:
1 <= x <= 1000Required range:
x >= 0Previous
Update TenantUpdate tenant settings and configuration.
**Purpose:** Complete your organization setup or modify settings
**👤 For Business Users After Signup:**
After signing up, your tenant is auto-created with minimal fields (just name).
Use this endpoint to complete your organization setup:
- Set your organization name properly
- Configure billing plan (starter/business/enterprise)
- Set usage limits (max_concurrent_calls, monthly_call_limit)
- Enable features (SIP, recording, analytics)
- Configure compliance (HIPAA, PCI for healthcare/finance)
**What it does:**
- Update organization name and billing plan
- Adjust usage limits and concurrent call capacity
- Enable/disable features (SIP, recording, analytics)
- Change compliance settings (HIPAA, PCI)
- Update SIP credentials (automatically encrypted)
- Modify webhook configuration for integrations
**Common Use Cases:**
- **Initial Setup:** After signup, set your org name and billing plan
- **Upgrade subscription:** Change billing_plan, increase limits
- **Enable phone calls:** Set sip_enabled=true, configure SIP details
- **Enable enterprise features:** Set hipaa_enabled=true, pci_enabled=true
- **Update webhook:** Change webhook_url for event notifications
**Your tenant_id = your owner_id** (returned in login token)
**Security Notes:**
- SIP passwords are automatically encrypted before storage
- Webhook secrets are stored securely
- All changes are logged for audit trail
Next
Get Tenant