API

オーディエンスを一覧する

オーディエンスとは、このワークスペース内の連絡先に名前を付けたリストです。すべての連絡先は、存在した瞬間から組み込みのデフォルトオーディエンスに入っており、その行を示すのが `builtin` です。それ以外は自由に作成・追加・削除できます。デフォルトオーディエンスが先頭に来て、残りは新しい順です。このバージョンはリストを管理するだけで送信は行わないため、一斉配信のエンドポイントを探す必要はありません。

GETapi.openemail.uk/audiences

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

GET /audiences

オーディエンスとは、このワークスペース内の連絡先に名前を付けたリストです。すべての連絡先は、存在した瞬間から組み込みのデフォルトオーディエンスに入っており、その行を示すのが builtin です。それ以外は自由に作成・追加・削除できます。デフォルトオーディエンスが先頭に来て、残りは新しい順です。このバージョンはリストを管理するだけで送信は行わないため、一斉配信のエンドポイントを探す必要はありません。

例

audiences:read が必要です。limit は最大 100、既定値は 25 です。

curl

curl "$OE/audiences" -H "$AUTH"

レスポンス

{  "object": "list",  "data": [    {      "object": "audience",      "id": "aud_9f2c4b7e1a0d63d84c5f2e7b",      "name": "All contacts",      "description": null,      "builtin": "default",      "contactCount": 412,      "createdAt": "2026-08-01T10:00:00.000Z",      "updatedAt": "2026-08-01T10:00:00.000Z"    }  ],  "hasMore": false,  "nextCursor": null}

名前ではなく builtin で分岐してください。デフォルトオーディエンスは誰でも名前を変更でき、変わりうるのはその名前だけです。

デフォルトオーディエンスは最初の読み取り時に解決されるため、一度もオーディエンスを作ったことのないワークスペースでも、ちょうど 1 行が一覧されます。

contactCount は読み取った時点で数えられるので、作成をはさんだ 2 回の読み取りは 1 件ずれます。名前は一意ではないため、名前ではなく id を保存してください。