Workspaces API

Base path: /api/workspaces

Workspaces are the top-level tenancy unit. Every extension installation, capability registration, and event subscription is scoped to a workspace.

Create Workspace

Requires ADMIN role.

POST /api/workspaces
Content-Type: application/json

Request Body

Field	Type	Required	Description
key	string	✅	Unique machine-readable key (e.g. acme). Used in workspace DB names.
name	string	✅	Human-readable display name

Example

curl -X POST http://localhost:8080/api/workspaces \
  -H "Content-Type: application/json" \
  -b cookies.txt \
  -d '{"key": "acme", "name": "Acme Corp"}'

Response 200 OK

{
  "code": "SUCCESS",
  "data": {
    "id": "ws-uuid-...",
    "key": "acme",
    "name": "Acme Corp",
    "createdAt": "2026-04-13T01:00:00Z"
  }
}

---

List Workspaces

Returns all workspaces the current user has access to.

GET /api/workspaces

---

Get Workspace

Requires ADMIN role or workspace membership.

GET /api/workspaces/{workspaceId}

---

Members

Add Member

Requires ADMIN role or workspace ADMIN role.

POST /api/workspaces/{workspaceId}/members
Content-Type: application/json

Request Body

Field	Type	Required	Description
userId	string	✅	ID of the user to add
role	string	✅	Workspace role (e.g. ADMIN, MEMBER)

Example

curl -X POST http://localhost:8080/api/workspaces/ws-uuid/members \
  -H "Content-Type: application/json" \
  -b cookies.txt \
  -d '{"userId": "user-uuid", "role": "MEMBER"}'

---

List Members

Requires ADMIN role or workspace membership.

GET /api/workspaces/{workspaceId}/members

---

Remove Member

Requires ADMIN role or workspace ADMIN role.

DELETE /api/workspaces/{workspaceId}/members/{userId}

---

User Management

Base path: /api/admin/users

All endpoints require ADMIN role.

Create User

POST /api/admin/users
Content-Type: application/json

Request Body

Field	Type	Required	Description
email	string	✅	Unique email address
fullName	string	✅	Display name
password	string	✅	Initial password
roles	string[]	✅	Platform roles: ADMIN, USER

---

List Users

GET /api/admin/users

---

Get User

GET /api/admin/users/{userId}

---

Update User

PUT /api/admin/users/{userId}
Content-Type: application/json

---

Delete User

DELETE /api/admin/users/{userId}