Space Docs
Domain Model

Workspace

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYes—Id
createdAtstring.date-timeYes—Created at
updatedAtstring.date-timeYes—Updated at
namestringYes—Name
keystringYes—Key
descriptionstringNo—Description
workspaceTypeenum(master, standard, template_based, archived)Yes—Workspace type
statusenum(active, archived)Yes—Status
parentWorkspaceIdstringNo—ID of the associated parent workspace
createdBystringNo—Created by
archivedAtstring.date-timeNo—Archived at
archivedBystringNo—Archived by

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
namestringYes—Name
keystringYes—Key
descriptionstringNo—Description
workspaceTypeenum(master, standard, template_based, archived)Yes"standard"Workspace type
statusenum(active, archived)Yes"active"Status
parentWorkspaceIdstringNo—ID of the associated parent workspace
createdBystringNo—Created by
archivedAtstring.date-timeNo—Archived at
archivedBystringNo—Archived by

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
namestringNo—Name
keystringNo—Key
descriptionstringNo—Description
statusenum(active, archived)No—Status
parentWorkspaceIdstringNo—ID of the associated parent workspace
createdBystringNo—Created by
archivedAtstring.date-timeNo—Archived at
archivedBystringNo—Archived by

On this page