Workspace API

Workspace CRUD and member management.

List Workspaces

GET /v1/workspaces

Parameters:

Parameter	Description
`limit`	Default 20
`cursor`	Pagination
`status`	`active` / `archived`

Response:

{
  "data": [
    {
      "id": "ws-001",
      "name": "CS Team",
      "description": "CS bot + FAQ knowledge base",
      "type": "team",
      "owner_id": "u-001",
      "member_count": 12,
      "status": "active",
      "created_at": "2026-01-15T10:00:00Z"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

Create a Workspace

POST /v1/workspaces

Request:

{
  "name": "Marketing Team",
  "description": "...",
  "type": "team",
  "join_policy": "approve_required"
}

Get Detail

GET /v1/workspaces/{id}

Update

PATCH /v1/workspaces/{id}

{ "name": "New name", "description": "..." }

Delete

DELETE /v1/workspaces/{id}

Deletion is irreversible

All internal Agent / Workflow / Knowledge base / Tool configurations are invalidated. Back up first.

Member Management

List Members

GET /v1/workspaces/{id}/members

Add a Member

POST /v1/workspaces/{id}/members

{
  "user_id": "u-005",
  "role": "developer"
}

Role value	Meaning
`admin`	Workspace administrator
`developer`	App builder
`user`	Regular user
`readonly`	Read-only

Remove a Member

DELETE /v1/workspaces/{id}/members/{user_id}

Transfer Ownership

POST /v1/workspaces/{id}/transfer

{ "new_owner_id": "u-002" }

Only the current owner can call.

API · Workspace