Workspaces

Workspace management

List workspaces

Lists all workspaces in the user's organization.

Query parameters

• organization_public_id string — Filter by organization. Defaults to the user's current organization.

Response 200 — Successful response

• ok boolean — required
• workspaces WorkspaceListItem[] — required
  • public_id string — required
  • name string — required
  • active boolean — required
  • favorite boolean — required
  • provision_status string — required

{
  "ok": true,
  "workspaces": [
    {
      "public_id": "workm4lz2mp899l2i7h9lk9u84azg3",
      "name": "production-analytics",
      "active": true,
      "favorite": true,
      "provision_status": "provisioned"
    }
  ]
}

Errors

Create a workspace

Creates a new workspace in the specified organization.

Request body

• name string — required. Name for the new workspace.
• organization_public_id string — Target organization. Defaults to the user's current organization.

{
  "name": "production-analytics"
}

Response 201 — Workspace created

• ok boolean — required
• workspace WorkspaceDetail — required
  • public_id string — required
  • name string — required
  • provision_status string — required

{
  "ok": true,
  "workspace": {
    "public_id": "workm4lz2mp899l2i7h9lk9u84azg3",
    "name": "production-analytics",
    "provision_status": "pending"
  }
}

Errors

Delete a workspace

Hard-deletes the workspace. Namespace, storage, and catalog deprovisioning runs asynchronously after the row is removed.

Response 204 — Workspace deleted

Errors