Space fields

​
List effective Space field definitions

Without project_id returns workspace fields only. With it includes that project, workspace fields first and each scope ordered by position. Includes read-only system fields, which are never stored.

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    }  ]}

Get your Orchestor API key

Create an API key in your workspace settings.

Authorizations

Satisfy one of these options:

  • Session cookie
  • API key

Authentication details

cookie
wos-session

Browser session established by signing in to the web app. The server checks your workspace membership and permissions. Supply X-Workspace-ID for workspace-scoped operations. For server-to-server requests, use an API key when the operation supports it.

Query Parameters

project_idstringquery
String length
≥ 1

Headers

X-Workspace-IDstringheader

Workspace to access. With a workspace-scoped API key, the server derives this value from the key, so the header is optional. If supplied, it must match the credential workspace or the request returns 403 workspace_mismatch. For interactive session requests, supply this header to select a workspace where you are a member. A project ID cannot be used as a workspace ID.

Example"wks_abc123"

Response

application/json

Definitions and system fields

dataSpaceField[]required
data[]SpaceField
data[].archived_atstring | nullrequiredformat:date-time
data[].configobjectrequired
data[].config.*any
data[].created_atstringrequiredformat:date-time
data[].idstringrequired
data[].is_requiredbooleanrequired
data[].positionintegerrequired
data[].project_idstring | nullrequired
data[].slugstringrequired
data[].titlestringrequired
data[].typestringenum<string>required
Allowed
textlong_textnumbercheckboxselectmulti_selectdatememberurltimecodetime_rangesegment_listobject
data[].updated_atstringrequiredformat:date-time
data[].workspace_idstringrequired
system_fieldsobject[]required
system_fields[]object
system_fields[].slugstringrequired
system_fields[].titlestringrequired
system_fields[].typestringenum<string>required
Allowed
textlong_textnumbercheckboxselectmulti_selectdatememberurltimecodetime_rangesegment_listobject
system_fields[].videoboolean