The Workspace object
A stored-memory destination, its configuration and effective access.
Use a person's credentials to create, read, update or archive a shared Workspace and manage its direct membership. API keys access memory within their assignments through Consolidate, Experiences, Engrams and Recall.
Deletion clears an archived Workspace's data and returns a separate progress result. Default
personal Workspaces have different lifecycle rules. See Workspaces for these
rules and inherited access. include=members loads the initial membership page on detail reads.
Available operations
/v1/workspacesCreate a WorkspaceGET/v1/workspacesList WorkspacesGET/v1/workspaces/{id}Retrieve a WorkspacePATCH/v1/workspaces/{id}Update a WorkspacePOST/v1/workspaces/{id}/archiveArchive a WorkspaceDELETE/v1/workspaces/{id}Delete a Workspace's dataGET/v1/workspaces/{id}/membersList Workspace membersPUT/v1/workspaces/{id}/members/{userId}Set Workspace membershipDELETE/v1/workspaces/{id}/members/{userId}Remove Workspace membershipThe Workspace object
Attributes
These are response fields. “Always present” can still allow null; “conditional” means the field can be omitted.
namestringalways presentDisplay name. Renaming does not change the Workspace ID.
statusstringalways presentCurrent Workspace lifecycle state.
kindstringalways presentShared Workspace or provisioned personal Default Workspace. Personal Workspaces have separate lifecycle rules.
ownerUserIdstringconditionalOwner of a personal Workspace, when applicable.
synthesisCadencestringconditionalConfigured consolidation cadence, when set.
createdByUserIdstringalways presentPerson who created the Workspace.
createdAtstringalways presentRecorded Workspace creation time.
updatedAtstringalways presentRecorded Workspace configuration update time.
_etagstringconditionalRevision for an If-Match update or archive, when available.
workspaceRolestringconditionalThe signed-in person's effective Workspace role, when loaded.
viastringconditionalSource of effective access, such as direct or inherited membership, when loaded.
membersobjectconditionalInitial membership page, loaded by include=members on the detail read. Follow its nextPageUrl for more.
Show nested fields
objectstringalways presentAllowed: "list"
urlstringalways presentdataarrayalways presentShow item fields
objectstringalways presentAllowed: "organization_member""workspace_member"
idstringalways presentMin length: 1
userIdstringalways presentMin length: 1
organizationstringalways presentworkspacestringconditionalnamestringconditionalemailstringconditionalrolestringconditionalworkspaceRolestringconditionalorgRolestringconditionalviastringconditionaladdedAtstringconditionaladdedByUserIdstringconditionalpermissionsarrayconditionalShow item fields
memberClassstringconditionalhasSignedInbooleanconditionaljoinedAtstringconditionalnextPageUrlstring | nullalways present