Skip to main content
GET
Get the tenant's email sender configuration and domain status
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

GET /tenant/email-settings Description: The tenant’s email domain verification status plus the effective sender address/name that outbound email will currently use. Branding (fromName, replyTo, logoUrl, primaryColor, companyName, companyAddress, websiteUrl, footerText, unsubscribeUrl) is not part of this response — read it from GET /capabilities/email-branding instead. Authorization:
  • Required role: user or higher
Method: GET

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Response

Email settings retrieved

No branding key. Email branding is read separately from GET /capabilities/email-branding.

status
string
Example:

"success"

data
object