Space fields

​
Create a Space field definition

Requires workspace:settings. Slugs cannot collide within a workspace/project scope chain.

POST
/v1/space/fields
curl -X POST "https://api.orchestor.io/v1/space/fields" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123" \  -H "Content-Type: application/json" \  -d '{  "config": {},  "is_required": false,  "position": 0,  "project_id": null,  "slug": "string",  "title": "string",  "type": "text"}'
{  "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>"  }}

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.

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"

Bodyapplication/jsonrequired

Match exactly one of the following

Variant 1: object

Additional properties
Not allowed
configobjectbodyrequired
Additional properties
Not allowed
is_requiredbooleanbodydefault:false
positionintegerbodydefault:0
project_idstring | nullbodydefault:null
String length
≥ 1
slugstringbodyrequired
String length
≤ 128
Pattern
^[a-z][a-z0-9_]*$
titlestringbodyrequired
String length
≥ 1, ≤ 256
typestringenum<string>bodyrequired
Allowed
text

Variant 2: object

Additional properties
Not allowed
configobjectbodyrequired
Additional properties
Not allowed
is_requiredbooleanbodydefault:false
positionintegerbodydefault:0
project_idstring | nullbodydefault:null
String length
≥ 1
slugstringbodyrequired
String length
≤ 128
Pattern
^[a-z][a-z0-9_]*$
titlestringbodyrequired
String length
≥ 1, ≤ 256
typestringenum<string>bodyrequired
Allowed
long_text

Variant 3: object

Additional properties
Not allowed
configobjectbodyrequired
Additional properties
Not allowed
config.scaleintegerbodyrequired
Value range
≥ 0, ≤ 6
is_requiredbooleanbodydefault:false
positionintegerbodydefault:0
project_idstring | nullbodydefault:null
String length
≥ 1
slugstringbodyrequired
String length
≤ 128
Pattern
^[a-z][a-z0-9_]*$
titlestringbodyrequired
String length
≥ 1, ≤ 256
typestringenum<string>bodyrequired
Allowed
number

Variant 4: object

Additional properties
Not allowed
configobjectbodyrequired
Additional properties
Not allowed
is_requiredbooleanbodydefault:false
positionintegerbodydefault:0
project_idstring | nullbodydefault:null
String length
≥ 1
slugstringbodyrequired
String length
≤ 128
Pattern
^[a-z][a-z0-9_]*$
titlestringbodyrequired
String length
≥ 1, ≤ 256
typestringenum<string>bodyrequired
Allowed
checkbox

Variant 5: object

Additional properties
Not allowed
configobjectbodyrequired
Additional properties
Not allowed
config.optionsobject[]bodyrequired
Item count
≥ 1
config.options[]objectbody
Additional properties
Not allowed
config.options[].colorstringbody
config.options[].idstringbodyrequired
String length
≥ 1
config.options[].labelstringbodyrequired
String length
≥ 1
is_requiredbooleanbodydefault:false
positionintegerbodydefault:0
project_idstring | nullbodydefault:null
String length
≥ 1
slugstringbodyrequired
String length
≤ 128
Pattern
^[a-z][a-z0-9_]*$
titlestringbodyrequired
String length
≥ 1, ≤ 256
typestringenum<string>bodyrequired
Allowed
select

Variant 6: object

Additional properties
Not allowed
configobjectbodyrequired
Additional properties
Not allowed
config.optionsobject[]bodyrequired
Item count
≥ 1
config.options[]objectbody
Additional properties
Not allowed
config.options[].colorstringbody
config.options[].idstringbodyrequired
String length
≥ 1
config.options[].labelstringbodyrequired
String length
≥ 1
is_requiredbooleanbodydefault:false
positionintegerbodydefault:0
project_idstring | nullbodydefault:null
String length
≥ 1
slugstringbodyrequired
String length
≤ 128
Pattern
^[a-z][a-z0-9_]*$
titlestringbodyrequired
String length
≥ 1, ≤ 256
typestringenum<string>bodyrequired
Allowed
multi_select

Variant 7: object

Additional properties
Not allowed
configobjectbodyrequired
Additional properties
Not allowed
is_requiredbooleanbodydefault:false
positionintegerbodydefault:0
project_idstring | nullbodydefault:null
String length
≥ 1
slugstringbodyrequired
String length
≤ 128
Pattern
^[a-z][a-z0-9_]*$
titlestringbodyrequired
String length
≥ 1, ≤ 256
typestringenum<string>bodyrequired
Allowed
date

Variant 8: object

Additional properties
Not allowed
configobjectbodyrequired
Additional properties
Not allowed
config.multiplebooleanbodyrequired
is_requiredbooleanbodydefault:false
positionintegerbodydefault:0
project_idstring | nullbodydefault:null
String length
≥ 1
slugstringbodyrequired
String length
≤ 128
Pattern
^[a-z][a-z0-9_]*$
titlestringbodyrequired
String length
≥ 1, ≤ 256
typestringenum<string>bodyrequired
Allowed
member

Variant 9: object

Additional properties
Not allowed
configobjectbodyrequired
Additional properties
Not allowed
is_requiredbooleanbodydefault:false
positionintegerbodydefault:0
project_idstring | nullbodydefault:null
String length
≥ 1
slugstringbodyrequired
String length
≤ 128
Pattern
^[a-z][a-z0-9_]*$
titlestringbodyrequired
String length
≥ 1, ≤ 256
typestringenum<string>bodyrequired
Allowed
url

Variant 10: object

Additional properties
Not allowed
configobjectbodyrequired
Additional properties
Not allowed
is_requiredbooleanbodydefault:false
positionintegerbodydefault:0
project_idstring | nullbodydefault:null
String length
≥ 1
slugstringbodyrequired
String length
≤ 128
Pattern
^[a-z][a-z0-9_]*$
titlestringbodyrequired
String length
≥ 1, ≤ 256
typestringenum<string>bodyrequired
Allowed
timecode

Variant 11: object

Additional properties
Not allowed
configobjectbodyrequired
Additional properties
Not allowed
is_requiredbooleanbodydefault:false
positionintegerbodydefault:0
project_idstring | nullbodydefault:null
String length
≥ 1
slugstringbodyrequired
String length
≤ 128
Pattern
^[a-z][a-z0-9_]*$
titlestringbodyrequired
String length
≥ 1, ≤ 256
typestringenum<string>bodyrequired
Allowed
time_range

Variant 12: object

Additional properties
Not allowed
configobjectbodyrequired
Additional properties
Not allowed
config.item_schemaSpaceJsonSchemabodyrequired
Additional properties
Not allowed
config.item_schema.descriptionstringbody
config.item_schema.enumany[]body
Item count
≥ 1
config.item_schema.enum[]anybody
config.item_schema.itemsSpaceJsonSchemabody
config.item_schema.maximumnumberbody
config.item_schema.minimumnumberbody
config.item_schema.propertiesobjectbody
config.item_schema.properties.*SpaceJsonSchemabody
config.item_schema.requiredstring[]body
config.item_schema.required[]stringbody
config.item_schema.typestringenum<string>bodyrequired
Allowed
stringnumberintegerbooleanarrayobject
is_requiredbooleanbodydefault:false
positionintegerbodydefault:0
project_idstring | nullbodydefault:null
String length
≥ 1
slugstringbodyrequired
String length
≤ 128
Pattern
^[a-z][a-z0-9_]*$
titlestringbodyrequired
String length
≥ 1, ≤ 256
typestringenum<string>bodyrequired
Allowed
segment_list

Variant 13: object

Additional properties
Not allowed
configobjectbodyrequired
Additional properties
Not allowed
config.schemaSpaceJsonSchema & object | nullbodyrequired

All of the following apply

Variant 1: SpaceJsonSchema

Additional properties
Not allowed
config.schema.descriptionstringbody
config.schema.enumany[]body
Item count
≥ 1
config.schema.enum[]anybody
config.schema.itemsSpaceJsonSchemabody
config.schema.maximumnumberbody
config.schema.minimumnumberbody
config.schema.propertiesobjectbody
config.schema.properties.*SpaceJsonSchemabody
config.schema.requiredstring[]body
config.schema.required[]stringbody
config.schema.typestringenum<string>bodyrequired
Allowed
stringnumberintegerbooleanarrayobject

Variant 2: object | null

config.schemaobject | nullbody
is_requiredbooleanbodydefault:false
positionintegerbodydefault:0
project_idstring | nullbodydefault:null
String length
≥ 1
slugstringbodyrequired
String length
≤ 128
Pattern
^[a-z][a-z0-9_]*$
titlestringbodyrequired
String length
≥ 1, ≤ 256
typestringenum<string>bodyrequired
Allowed
object

Response

application/json

Space resource

dataSpaceFieldrequired
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