Read this workspace's inbound email address
The address customers write to, or `null` when none has been minted.
/v1/channels/email/addressViewer- Operation id
- get_inbound_address
- Access
- Any workspace role can call this.
/v1/channels/email/addressThe address customers write to, or null when none has been minted.
A workspace with no address is a 200 describing that fact, not a 404: the channel exists, this workspace simply has not connected it, and the two are different answers a connection screen has to be able to tell apart.
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.
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/address"{ "address": "string", "domain": "string", "minted": true}