Skip to content
AugentaDocsOpen console ↗
The Workspace object

Documentation

API reference
View Markdown

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

Usage and lifecycle →

The Workspace object

Attributes

These are response fields. “Always present” can still allow null; “conditional” means the field can be omitted.

objectstringalways present

The resource type. Always workspace.

Allowed: "workspace"

idstringalways present

Workspace identity used in routes and memory selectors.

Min length: 1

orgIdstringalways present

Owning Organization's Augenta ID.

Min length: 1

namestringalways present

Display name. Renaming does not change the Workspace ID.

statusstringalways present

Current Workspace lifecycle state.

kindstringalways present

Shared Workspace or provisioned personal Default Workspace. Personal Workspaces have separate lifecycle rules.

ownerUserIdstringconditional

Owner of a personal Workspace, when applicable.

synthesisCadencestringconditional

Configured consolidation cadence, when set.

createdByUserIdstringalways present

Person who created the Workspace.

createdAtstringalways present

Recorded Workspace creation time.

updatedAtstringalways present

Recorded Workspace configuration update time.

_etagstringconditional

Revision for an If-Match update or archive, when available.

workspaceRolestringconditional

The signed-in person's effective Workspace role, when loaded.

viastringconditional

Source of effective access, such as direct or inherited membership, when loaded.

membersobjectconditional

Initial membership page, loaded by include=members on the detail read. Follow its nextPageUrl for more.

Show nested fields
objectstringalways present

Allowed: "list"

urlstringalways present
dataarrayalways present
Show item fields
objectstringalways present

Allowed: "organization_member""workspace_member"

idstringalways present

Min length: 1

userIdstringalways present

Min length: 1

organizationstringalways present
workspacestringconditional
namestringconditional
emailstringconditional
rolestringconditional
workspaceRolestringconditional
orgRolestringconditional
viastringconditional
addedAtstringconditional
addedByUserIdstringconditional
permissionsarrayconditional
Show item fields
memberClassstringconditional
hasSignedInbooleanconditional
joinedAtstringconditional
nextPageUrlstring | nullalways present