Read this workspace's connected sending domain
The connected domain, its per-record checks and the records to publish.
/v1/channels/email/sending-domainViewer- Operation id
- get_sending_domain
- Access
- Any workspace role can call this.
/v1/channels/email/sending-domainThe connected domain, its per-record checks and the records to publish.
A workspace with nothing connected is a 200 saying so, not a 404: the
connection screen has to tell "no domain" apart from "this route is gone".
Stored state, not a live provider call. verify is the route that asks.
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/sending-domain"{ "connected": true, "domain": "string", "from_address": "string", "mail_from_domain": "string", "fallback_to_minted": true, "sendable": true, "verified_at": "string", "checks": [ { "check": "dkim", "status": "not_started", "detail": "string", "remediation": "string", "last_checked_at": "2019-08-24T14:15:22Z" } ], "records": [ { "check": "dkim", "host": "string", "type": "CNAME", "value": "string", "ttl_seconds": 0 } ], "observations": [ { "check": "dkim", "host": "string", "type": "CNAME", "expected": "string", "observed": [ "string" ], "matches": true, "note": "string" } ]}