Workspaces
Manage workspaces, workspace checkout, and workspace members.
Workspace endpoints require bearer authentication.
Workspaces
| Method | Path | Purpose |
|---|---|---|
| GET | /v1/workspaces |
List accessible workspaces |
| POST | /v1/workspaces |
Create a workspace |
| PATCH | /v1/workspaces/:workspaceId |
Update workspace settings |
| POST | /v1/workspaces/:workspaceId/checkout |
Get workspace checkout URL |
Workspace plans are basic or pro.
Workspace name follows subdomain constraints: 3 to 30 characters, lowercase letters, numbers, and hyphens only. Reserved names are rejected. PATCH /v1/workspaces/:workspaceId uses PATCH semantics: omitted fields stay unchanged.
Workspace members
| Method | Path | Purpose |
|---|---|---|
| GET | /v1/workspaces/:workspaceId/members |
List members in a workspace |
| PUT | /v1/workspaces/:workspaceId/members |
Add/update members in bulk |
| DELETE | /v1/workspaces/:workspaceId/members/:userId |
Remove one member |
| DELETE | /v1/workspaces/:workspaceId/members |
Remove members in bulk |
Roles are owner, admin, and member.
Bulk member updates accept a list of user IDs and a role. Bulk deletes accept a list of user IDs.