Space/space Fields

​
有効な Space フィールド定義を一覧表示

project_id がない場合はワークスペースのフィールドのみを返します。指定した場合はそのプロジェクトも含め、ワークスペースのフィールドが先頭になり、各スコープは位置順に並べられます。保存されることのない読み取り専用のシステムフィールドも含まれます。

GET
/v1/space/fields
curl -X GET "https://api.orchestor.io/v1/space/fields" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123"
{  "data": [    {      "archived_at": "2026-01-01T00:00:00Z",      "config": {},      "created_at": "2026-01-01T00:00:00Z",      "id": "<string>",      "is_required": true,      "position": 0,      "project_id": "<string>",      "slug": "<string>",      "title": "<string>",      "type": "text",      "updated_at": "2026-01-01T00:00:00Z",      "workspace_id": "<string>"    }  ],  "system_fields": [    {      "slug": "<string>",      "title": "<string>",      "type": "text",      "video": true    }  ]}

Orchestor API キーを取得

ワークスペースの設定から API キーを作成します。

認証

次のいずれかの条件を満たしてください。

  • Session cookie
  • API key

認証の詳細

cookie
wos-session

ウェブアプリにサインインすることで確立されるブラウザセッションです。サーバーは、ワークスペースのメンバーシップと権限を確認します。ワークスペーススコープの操作には X-Workspace-ID を指定してください。サーバー間リクエストの場合、操作がサポートしていれば API キーを使用します。

クエリパラメータ

project_idstringquery
文字数
≥ 1

ヘッダー

X-Workspace-IDstringheader

アクセスするワークスペースです。ワークスペーススコープの API キーを使用する場合、サーバーはキーからこの値を導出するため、ヘッダーは任意です。指定する場合、認証情報のワークスペースと一致する必要があり、一致しない場合リクエストは 403 workspace_mismatch を返します。インタラクティブなセッションリクエストの場合、メンバーになっているワークスペースを選択するためにこのヘッダーを指定します。プロジェクト ID をワークスペース ID として使用することはできません。

例"wks_abc123"

レスポンス

application/json

定義とシステムフィールド

dataSpaceField[]必須
data[]SpaceField
data[].archived_atstring | null必須形式:date-time
data[].configobject必須
data[].config.*any
data[].created_atstring必須形式:date-time
data[].idstring必須
data[].is_requiredboolean必須
data[].positioninteger必須
data[].project_idstring | null必須
data[].slugstring必須
data[].titlestring必須
data[].typestringenum<string>必須
許可される値
textlong_textnumbercheckboxselectmulti_selectdatememberurltimecodetime_rangesegment_listobject
data[].updated_atstring必須形式:date-time
data[].workspace_idstring必須
system_fieldsobject[]必須
system_fields[]object
system_fields[].slugstring必須
system_fields[].titlestring必須
system_fields[].typestringenum<string>必須
許可される値
textlong_textnumbercheckboxselectmulti_selectdatememberurltimecodetime_rangesegment_listobject
system_fields[].videoboolean