Stable API tag

workspaces

Workspace scoping

5 paths · 7 operations

/v1/workspaces

get

List workspaces in the resolved tenant

Operation ID: listWorkspaces
Authentication: Bearer token
Request body: None

Parameters
Name	In	Required	Type
X-Olivares-Tenant	header	no	string · uuid
limit	query	no	integer
cursor	query	no	string

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

post

Create a workspace (tenant admin, AAL3 step-up)

Operation ID: createWorkspace
Authentication: Bearer token
Request body: Present · required

Parameters
Name	In	Required	Type
X-Olivares-Tenant	header	no	string · uuid

Response codes

201 · 400 · 401 · 403 · 404 · 409 · 429

/v1/workspaces/{id}

get

Get a workspace by ID

Operation ID: getWorkspace
Authentication: Bearer token
Request body: None

Parameters
Name	In	Required	Type
id	path	yes	string · uuid
X-Olivares-Tenant	header	no	string · uuid

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

patch

Update a workspace

Operation ID: updateWorkspace
Authentication: Bearer token
Request body: Present · required

Parameters
Name	In	Required	Type
id	path	yes	string · uuid
X-Olivares-Tenant	header	no	string · uuid

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/workspaces/{id}/contents

get

Every kind that declares workspace lineage, counted in the workspace and sorted by kind; a capped count is a floor (501 when the census is not wired)

Operation ID: getWorkspaceContents
Authentication: Bearer token
Request body: None

Parameters
Name	In	Required	Type
id	path	yes	string · uuid
X-Olivares-Tenant	header	no	string · uuid

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/workspaces/{id}/parent

put

Place a workspace (a department) under another workspace of the same tenant, or make it a root with an empty parent_id; the subtree moves with it (owner, AAL3 step-up)

Operation ID: setWorkspaceParent
Authentication: Bearer token
Request body: Present · required

Parameters
Name	In	Required	Type
id	path	yes	string · uuid
X-Olivares-Tenant	header	no	string · uuid

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/workspaces/{id}/summary

get

A workspace with counts of its scoped entities; a *_capped count is a FLOOR (at least N), never a total

Operation ID: getWorkspaceSummary
Authentication: Bearer token
Request body: None

Parameters
Name	In	Required	Type
id	path	yes	string · uuid
X-Olivares-Tenant	header	no	string · uuid

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429