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

ラベルを一覧する

メールボックス上のすべてのラベルを、システムのものもユーザーのものも、表示色とともに返します。

GETapi.openemail.uk/labels

実際の呼び出しを、ご自身のキーで自分のワークスペースに対して実行します。

GET /labels

メールボックス上のすべてのラベルを、システムのものもユーザーのものも、表示色とともに返します。

ラベルの id

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

ラベルの id はそのメールボックス固有のものです。組み立てるのではなく一覧から読み取ってください。その形式は契約の一部ではありません。

labels:read が必要です。

curl
curl "$OE/labels" -H "$AUTH"
レスポンス
{  "object": "list",  "data": [    { "object": "label", "id": "INBOX", "name": "Inbox", "type": "system", "color": null },    {      "object": "label",      "id": "USER_INVOICES",      "name": "Invoices",      "type": "user",      "color": { "backgroundColor": "#e8f0fe", "textColor": "#1967d2" }    }  ]}

システムラベル(INBOXSENTSPAMTRASHUNREADSTARRED)も返ります。これらはスレッドに追加したり外したりできますが、名前の変更や削除はできません。