Skip to content
Authrim

Get tenant email settings

GET
/api/admin/tenants/{tenantId}/email-settings
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/tenants/example/email-settings \
  --header 'Authorization: Bearer <token>'

Returns tenant email failover settings and configured email notifier providers in effective priority order.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
tenantId
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
tenantId
required
string
settings
required
object
strategy
required
string
Allowed values: priority_failover
providerOrder
required
Array<string>
key
additional properties
providers
required
Array<object>
object
id
string
name
string
description
string
category
string
configSource
string
configured
boolean
missingRequiredFields
Array<string>
defaultFrom
string
key
additional properties
key
additional properties
Example 
{
  "tenantId": "tenant_123",
  "settings": {
    "strategy": "priority_failover",
    "providerOrder": [
      "notifier-resend",
      "notifier-sendgrid"
    ]
  },
  "providers": [
    {
      "id": "notifier-resend",
      "name": "Resend",
      "description": "Resend email provider",
      "category": "notification",
      "configSource": "tenant",
      "configured": true,
      "missingRequiredFields": [],
      "defaultFrom": "[email protected]"
    }
  ]
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}