Organization
最終更新: 2026年6月22日
Organization は Space を格納する最上位の入れ物です。会社やチーム単位が 1 つの Organization に対応し、その下に複数の Space を置きます。サブスクリプションプラン(plan)とメンバーシップは Organization レベルで管理されるため、決済とメンバー権限は Space ではなくこの Organization を基準に適用されます。
自分が所属する Organization の一覧は GET /me/organization-memberships で取得します。このリソースには全件を返すエンドポイントはありません。
リソース構造
以下は Organization「DailyWear カンパニー」の単一取得レスポンスです。sys(システム属性)と本文属性 name・description を持ちます。
{
"sys": {
"id": "ilLRJxDp",
"type": "Organization",
"createdBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
"createdAt": "2026-05-11T10:51:16.832Z",
"updatedBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
"updatedAt": "2026-05-11T10:51:16.832Z",
"version": 1,
"isOfficial": false,
"plan": { "sys": { "id": "free", "type": "Refer", "targetType": "Plan" } }
},
"name": "DailyWear カンパニー",
"description": "衣類・雑貨のオンラインショップ運営会社"
}主なキー:
name: Organization の名前です(1~64 文字)。会社やチームの表示名です。description: Organization に関する説明です(1~128 文字、任意)。plan: この Organization のサブスクリプションプランを指すRefer<Plan>です(例:free)。決済プランがここに紐づいています。isOfficial: 公式 Organization かどうかを示します(boolean)。
システム属性 (sys) と本文
すべての Organization は共通のシステム属性を sys オブジェクトに持ちます。createdBy・updatedBy は Refer の形({ "sys": { "id", "type": "Refer", "targetType" } })で入り、plan は Refer<Plan> です。
| 属性 | 型 | 説明 |
|---|---|---|
id | string | リソースの一意な識別子。 |
type | string | リソースの種類。Organization は常に "Organization"。 |
createdBy | Refer<User> | 作成したユーザー。 |
createdAt | string (date-time) | 作成日時。 |
updatedBy | Refer<User> | 最後に更新したユーザー。 |
updatedAt | string (date-time) | 最終更新日時。 |
version | integer (≥1) | リソースのバージョン。更新するたびに 1 ずつ上がります。 |
isOfficial | boolean | 公式 Organization かどうか。 |
plan | Refer<Plan> | サブスクリプションプラン。例: free。 |
本文属性:
| 属性 | 型 | 説明 |
|---|---|---|
name | string (1~64) | Organization 名。作成・更新時に指定します。 |
description | string (1~128) | Organization の説明。任意項目です。 |
icon | string (読み取り) / object (書き込み) | Organization のアイコン。レスポンスでは画像 URL の文字列です。更新リクエストでは、アップロードしたファイルを指すオブジェクト { "upload": { "sys": { ..., "targetType": "Upload" } } } として送ります(Upload API で取得した Upload を参照)。 |
Organization は発行(publish)の概念がない設定リソースです。そのため Content・Media と異なり sys に publish・archive・status がなく、version のみを持ちます。version は Organization を更新するたびに上がります。
API
以下のすべてのエンドポイントの基準 URL は https://cma.weegloo.com/v1 で、Authorization ヘッダーに CMA を認証する Bearer トークンが必要です。更新・部分更新では、楽観的同時実行制御のために X-Weegloo-Version ヘッダー(現在のリソースの sys.version)を併せて送る必要があります。作成と削除にはこのヘッダーはありません。
関連ドキュメント
- Space: この Organization 配下の Space。
- Organization Membership: Organization のメンバーと、自分が所属する組織の取得。
