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

ワークスペースを一覧にする

その人が開けるすべてのワークスペース。アプリのワークスペース切り替えと同じく、所有しているものが先に並ぶ。

GET/workspaces

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

GET /workspaces

その人が開けるすべてのワークスペース。アプリのワークスペース切り替えと同じく、所有しているものが先に並ぶ。

例

account:read が必要。activeWorkspaceId はアプリがその人のために開くワークスペース、primaryWorkspaceId はその人が最初に作った、決して削除できないワークスペース、personalWorkspaceId はその人の個人スペースで、無料アドレスを保持し、data には含まれない。

curl
curl "$OE/workspaces" -H "$AUTH"
レスポンス
{  "object": "list",  "data": [    {      "object": "workspace",      "id": "10417196-e324-4283-af98-66ec62167c47",      "name": "Acme",      "slug": "acme",      "email": "[email protected]",      "isOwner": true,      "ownerId": "q7Vd3kX9mT2pLw8RzN4bYc6HfJ1sGa5E",      "plan": "business",      "markUrl": null,      "wordmarkUrl": null,      "createdAt": "2026-08-01T10:00:00.000Z"    }  ],  "activeWorkspaceId": "10417196-e324-4283-af98-66ec62167c47",  "primaryWorkspaceId": "10417196-e324-4283-af98-66ec62167c47",  "personalWorkspaceId": "5b1e7c40-2d9a-4f63-b8e1-0c4d7a2f9e15"}

これらの呼び出しはワークスペースではなく人に対して動作する。API キーは自分が属するワークスペースの所有者として、アプリはそれを接続した人として動作する。読み取りには account:read、変更には account:write が必要で、どちらもロールでは制限されない。

キーやアプリそのものは、ほかのすべての呼び出しで引き続きちょうど 1 つのワークスペースに対して動作する。ここでの操作がその範囲を広げることはない。

リファレンス