AuralisDocs
OperationsChannels and email

Read the address replies would be sent from

What a reply would go out as right now, without sending one.

/v1/channels/email/senderViewer
Operation id
get_sender
Access
Any workspace role can call this.
GET/v1/channels/email/sender

What a reply would go out as right now, without sending one.

A refusal is a 200 carrying refused_reason rather than an error status: the question was answered, and the answer is that this workspace currently cannot send. A 4xx here would be a screen that cannot distinguish "you have no verified domain" from "this route is broken".

Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.

Authorisation: any workspace role, including viewer. Reads are open to every member.

Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the channels:read scope, and the workspace role of the person who owns it must meet the floor above.

Authorization

AuthorizationBearer <token>

A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/channels/email/sender"
{  "address": "string",  "domain": "string",  "source": "string",  "fallback_reason": "string",  "refused_reason": "string"}