Skip to content

List sending identities

projectId
required
string

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

channelId
string

Filter to a specific channel (provider id).

Identities.

Media typeapplication/json
object
identities
Array<object>
object
id
string
projectId
string
channelId
string
label
string
fromAddress
string format: email
fromName
string | null
replyToAddress
string | null format: email
isDefault
boolean
status
string
Allowed values: active paused
createdAt
string | null format: date-time
updatedAt
string | null 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"
}