ドキュメント本文へスキップ
API

WebアプリのURL を取得する

ワークスペースの WebアプリのURL、そこでサインインできるかどうか、そして必要な CNAMEレコードです。設定されていない場合、`status` は `none` になり、`domains` にはその配下に設定できるドメインが列挙されます。

GET/app-host

実際の呼び出しをワークスペースに対して実行します。

GET /app-host

ワークスペースの WebアプリのURL、そこでサインインできるかどうか、そして必要な CNAMEレコードです。設定されていない場合、status は none になり、domains にはその配下に設定できるドメインが列挙されます。

WebアプリのURL とは

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

有料プランのワークスペースは、openemail.uk に加えて、検証済みドメインのいずれかのサブドメイン(mailbox.acme.com など)でも Web アプリを開けます。これはワークスペースの外観設定にあるブランドアプリタブで設定するアドレスで、1 つのワークスペースにつき最大 1 つです。

そこにサインインできるのは、ワークスペースのメンバー、そのアドレスのいずれかでサインインする人、保留中の招待を持つ人だけで、そこから送られるパスワードリセットや確認のメールを受け取るのもその人たちだけです。ワークスペースが外観ページでロゴを設定するまでは openemail.uk と同じ見た目で、設定すると私たちのものではなくワークスペースのロゴ、マーク、名前が表示されます。それ以降、OpenEmail がその人たちに送るメールにはブランドが入り、リンクはこのアドレスに戻り、そのドメインの署名レコードが確認されると、そのドメインの noreply@ から届きます。

必要なのは CNAMEレコード 1 つで、その内容は record に示されます。アドレスはレコードが応答して証明書が発行されるまで pending で、その後は active になります。無料プランでは保持されますが一時停止されます: paused が true になり、ワークスペースが再び有料プランになるまで誰もそこにサインインできません。

例

domains:read が必要です。

curl
curl "$OE/app-host" -H "$AUTH"
レスポンス
{  "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"}

読み取ると、前回のチェックから 15 秒以上経っていればアドレスが再チェックされるので、active が true になるのを待つにはこのルートをポーリングします。

active が true になるのは、status が active で、かつワークスペースが有料プランのときだけです。paused は、アドレスが設定されていてワークスペースが無料プランのときに true になります。

受信トレイを、
あなたの思いどおりに。

企業、AI、エージェント、個人利用のためのメールインフラ。スケール、プライバシー、コントロールのために設計。メールが最初から備えているべきだったすべて。

© 2026 OpenEmail. 無断転載を禁じます。