Skip to main content
GET
Get tenant

Authorizations

Authorization
string
header
required

Scoped API key created via POST /api/account/keys.

Path Parameters

id
string
required

Tenant ID

Response

OK

createdAt
string

When the tenant account was created

debugMode
boolean

Whether debug mode is enabled for verbose logging

email
string

Tenant email address

id
string

Unique tenant identifier

idpId
string

Identity provider subject ID (from JWT)

isActive
boolean

Whether the tenant account is active

logLevel
string

Logging verbosity: "debug", "info", "warn", "error"

mediaAutoPersist
boolean

Whether to automatically persist incoming media to S3

metadata
object

Custom key-value metadata for the tenant

msgRateLimit
integer

Messages per minute limit

name
string

Tenant display name

plan
string

Subscription plan (e.g. "free", "pro", "enterprise")

rateLimit
integer

API requests per minute limit

s3Bucket
string

S3 bucket name for media storage

s3Endpoint
string

S3-compatible endpoint URL for media storage

s3Region
string

AWS region code (e.g. "us-east-1")

sessionLimit
integer

Maximum number of concurrent WhatsApp sessions

updatedAt
string

When the tenant account was last updated