Zur Dokumentation springen
API

Die Web-App-Adresse abrufen

Die Web-App-Adresse des Workspace, ob man sich dort anmelden kann, und der CNAME-Eintrag, den sie braucht. Ist keine festgelegt, steht `status` auf `none`, und `domains` listet die Domains auf, unter denen sich eine einrichten lässt.

GET/app-host

Führt den echten Aufruf in Ihrem Workspace aus.

GET /app-host

Die Web-App-Adresse des Workspace, ob man sich dort anmelden kann, und der CNAME-Eintrag, den sie braucht. Ist keine festgelegt, steht status auf none, und domains listet die Domains auf, unter denen sich eine einrichten lässt.

Was die Web-App-Adresse ist

shell
export OE=https://api.openemail.ukexport AUTH="Authorization: Bearer $OPENEMAIL_API_KEY"

Ein Workspace mit einem kostenpflichtigen Tarif kann die Web-App zusätzlich zu openemail.uk unter einer Subdomain einer seiner verifizierten Domains öffnen, etwa mailbox.acme.com. Es ist die Adresse, die der Reiter Eigene Web-App in den Erscheinungsbild-Einstellungen des Workspace festlegt, und ein Workspace hat höchstens eine.

Nur die Mitglieder des Workspace, die Personen, die sich mit einer seiner Adressen anmelden, und alle mit einer offenen Einladung können sich dort anmelden, und nur sie erhalten von dort E-Mails zum Zurücksetzen des Passworts und zur Bestätigung. Die Adresse sieht wie openemail.uk aus, bis der Workspace auf seiner Erscheinungsbild-Seite ein Logo festlegt, und zeigt dann Logo, Zeichen und Namen des Workspace anstelle der unseren. Ab dann tragen die E-Mails, die OpenEmail ihnen schickt, die Marke, verlinken zurück auf die Adresse und kommen von noreply@ seiner Domain, sobald die Signatureinträge dieser Domain verifiziert sind.

Sie braucht einen CNAME-Eintrag, den record genau angibt. Die Adresse steht auf pending, bis der Eintrag antwortet und ihr Zertifikat ausgestellt ist, und danach auf active. Im kostenlosen Tarif bleibt sie erhalten, ist aber pausiert: paused ist true, und niemand kann sich dort anmelden, bis der Workspace wieder einen kostenpflichtigen Tarif hat.

Beispiel

Erfordert domains:read.

curl
curl "$OE/app-host" -H "$AUTH"
Antwort
{  "object": "app_host",  "id": "ahost_3f9c2a71d0b84e56a1c7f2e9",  "host": "mailbox.acme.com",  "domainId": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f",  "domain": "acme.com",  "status": "active",  "active": true,  "paused": false,  "target": "cname.openemail.uk",  "record": {    "type": "CNAME",    "name": "mailbox.acme.com",    "value": "cname.openemail.uk"  },  "error": null,  "checkedAt": "2026-10-01T09:12:30.000Z",  "verifiedAt": "2026-10-01T09:04:11.000Z",  "available": true,  "paidPlan": true,  "domains": ["acme.com"],  "suggested": "mailbox.acme.com"}

Das Lesen prüft die Adresse erneut, wenn ihre letzte Prüfung älter als 15 Sekunden ist, daher warten Sie, bis active true wird, indem Sie diese Route regelmäßig abfragen.

active ist nur dann true, wenn status auf active steht und der Workspace einen kostenpflichtigen Tarif hat. paused ist true, wenn eine Adresse festgelegt ist und der Workspace den kostenlosen Tarif hat.

Der Posteingang,
nach eigenen Regeln.

E-Mail-Infrastruktur für Unternehmen, KI, Agenten und persönliche E-Mail. Gebaut für Skalierung, Privatsphäre und Kontrolle. Alles, was E-Mail vom ersten Tag an hätte haben sollen.

© 2026 OpenEmail. Alle Rechte vorbehalten.