# 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](https://augenta.pages.dev/docs/workspaces.md) for these
rules and inherited access. `include=members` loads the initial membership page on detail reads.

## Available operations

* [POST `/v1/workspaces` — Create a Workspace](https://augenta.pages.dev/docs/api-reference/create-workspace.md)
* [GET `/v1/workspaces` — List Workspaces](https://augenta.pages.dev/docs/api-reference/list-workspaces.md)
* [GET `/v1/workspaces/{id}` — Retrieve a Workspace](https://augenta.pages.dev/docs/api-reference/get-workspace.md)
* [PATCH `/v1/workspaces/{id}` — Update a Workspace](https://augenta.pages.dev/docs/api-reference/update-workspace.md)
* [POST `/v1/workspaces/{id}/archive` — Archive a Workspace](https://augenta.pages.dev/docs/api-reference/archive-workspace.md)
* [DELETE `/v1/workspaces/{id}` — Delete a Workspace's data](https://augenta.pages.dev/docs/api-reference/delete-workspace.md)
* [GET `/v1/workspaces/{id}/members` — List Workspace members](https://augenta.pages.dev/docs/api-reference/list-workspace-members.md)
* [PUT `/v1/workspaces/{id}/members/{userId}` — Set Workspace membership](https://augenta.pages.dev/docs/api-reference/set-workspace-member.md)
* [DELETE `/v1/workspaces/{id}/members/{userId}` — Remove Workspace membership](https://augenta.pages.dev/docs/api-reference/remove-workspace-member.md)

## Attributes

These are response fields: always present can allow null; conditional fields can be omitted.

<a id="workspace-object"></a>

### `workspace.object`

`string` · always present

The resource type. Always workspace.

Allowed values: `"workspace"`.

<a id="workspace-id"></a>

### `workspace.id`

`string` · always present

Workspace identity used in routes and memory selectors.

Min length: `1`.

<a id="workspace-orgid"></a>

### `workspace.orgId`

`string` · always present

Owning Organization's Augenta ID.

Min length: `1`.

<a id="workspace-name"></a>

### `workspace.name`

`string` · always present

Display name. Renaming does not change the Workspace ID.

<a id="workspace-status"></a>

### `workspace.status`

`string` · always present

Current Workspace lifecycle state.

<a id="workspace-kind"></a>

### `workspace.kind`

`string` · always present

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

<a id="workspace-owneruserid"></a>

### `workspace.ownerUserId`

`string` · conditional

Owner of a personal Workspace, when applicable.

<a id="workspace-synthesiscadence"></a>

### `workspace.synthesisCadence`

`string` · conditional

Configured consolidation cadence, when set.

<a id="workspace-createdbyuserid"></a>

### `workspace.createdByUserId`

`string` · always present

Person who created the Workspace.

<a id="workspace-createdat"></a>

### `workspace.createdAt`

`string` · always present

Recorded Workspace creation time.

<a id="workspace-updatedat"></a>

### `workspace.updatedAt`

`string` · always present

Recorded Workspace configuration update time.

<a id="workspace-_etag"></a>

### `workspace._etag`

`string` · conditional

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

<a id="workspace-workspacerole"></a>

### `workspace.workspaceRole`

`string` · conditional

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

<a id="workspace-via"></a>

### `workspace.via`

`string` · conditional

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

<a id="workspace-members"></a>

### `workspace.members`

`object` · conditional

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

<a id="workspace-members-object"></a>

### `workspace.members.object`

`string` · always present

Allowed values: `"list"`.

<a id="workspace-members-url"></a>

### `workspace.members.url`

`string` · always present

<a id="workspace-members-data"></a>

### `workspace.members.data`

`array<value>` · always present

<a id="workspace-members-data-object"></a>

### `workspace.members.data.object`

`string` · always present

Allowed values: `"organization_member"`, `"workspace_member"`.

<a id="workspace-members-data-id"></a>

### `workspace.members.data.id`

`string` · always present

Min length: `1`.

<a id="workspace-members-data-userid"></a>

### `workspace.members.data.userId`

`string` · always present

Min length: `1`.

<a id="workspace-members-data-organization"></a>

### `workspace.members.data.organization`

`string` · always present

<a id="workspace-members-data-workspace"></a>

### `workspace.members.data.workspace`

`string` · conditional

<a id="workspace-members-data-name"></a>

### `workspace.members.data.name`

`string` · conditional

<a id="workspace-members-data-email"></a>

### `workspace.members.data.email`

`string` · conditional

<a id="workspace-members-data-role"></a>

### `workspace.members.data.role`

`string` · conditional

<a id="workspace-members-data-workspacerole"></a>

### `workspace.members.data.workspaceRole`

`string` · conditional

<a id="workspace-members-data-orgrole"></a>

### `workspace.members.data.orgRole`

`string` · conditional

<a id="workspace-members-data-via"></a>

### `workspace.members.data.via`

`string` · conditional

<a id="workspace-members-data-addedat"></a>

### `workspace.members.data.addedAt`

`string` · conditional

<a id="workspace-members-data-addedbyuserid"></a>

### `workspace.members.data.addedByUserId`

`string` · conditional

<a id="workspace-members-data-permissions"></a>

### `workspace.members.data.permissions`

`array<string>` · conditional

<a id="workspace-members-data-memberclass"></a>

### `workspace.members.data.memberClass`

`string` · conditional

<a id="workspace-members-data-hassignedin"></a>

### `workspace.members.data.hasSignedIn`

`boolean` · conditional

<a id="workspace-members-data-joinedat"></a>

### `workspace.members.data.joinedAt`

`string` · conditional

<a id="workspace-members-nextpageurl"></a>

### `workspace.members.nextPageUrl`

`string | null` · always present

## Example object

```json
{
  "object": "workspace",
  "id": "release-guides",
  "orgId": "org_example",
  "name": "Release guides",
  "status": "active",
  "kind": "shared",
  "createdByUserId": "user_example",
  "createdAt": "2026-10-27T12:00:00Z",
  "updatedAt": "2026-10-27T12:00:00Z",
  "workspaceRole": "admin"
}
```
