Skip to content

List email sending channels (providers)

projectId
required
string

Tenant project id (row-level isolation on every query).

Providers list. configJson is never returned; configConfigured is a boolean flag.

Media typeapplication/json
object
providers
Array<object>

Email sending channel. configJson is never serialized; configConfigured signals whether secrets are stored.

object
id
string
projectId
string
name
string
kind
string
Allowed values: log resend sendgrid mailgun aliyun cf_email
status
string
Allowed values: active paused disabled
fromAddress
string format: email
replyToAddress
string | null format: email
webhookId
string
rateLimitPerSecond
integer
dailyLimit
integer | null
transactionalReservePercent
integer
marketingDailyLimit
integer | null
sentToday
integer
configConfigured
boolean
lastHealthAt
string | null format: date-time
lastHealthStatus
string | null
createdAt
string format: date-time
updatedAt
string format: date-time

Not authenticated (no valid session/principal).

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}

Authenticated but lacks the required project role.

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}