Read this workspace's connected mailbox
The connected mailbox and its per-check health, from stored state.
/v1/channels/email/mailboxViewer- Operation id
- get_mailbox
- Access
- Any workspace role can call this.
/v1/channels/email/mailboxThe connected mailbox and its per-check health, from stored state.
A workspace with nothing connected is a 200 saying so, not a 404, because the connection screen has to tell "no mailbox" apart from "this route is gone".
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/mailbox"{ "connected": true, "email_address": "string", "scopes": [ "string" ], "sendable": true, "polling": true, "inbound_cursor_set": true, "connected_at": "string", "healthy_at": "string", "last_polled_at": "string", "sent_today": 0, "checks": [ { "check": "authorisation", "status": "not_started", "detail": "string", "remediation": "string", "last_checked_at": "2019-08-24T14:15:22Z" } ]}