Workspaces
Manage workspaces, workspace checkout, and workspace members.
Workspace endpoints require bearer authentication.
Use workspace endpoints for organization setup and membership. Use project endpoints for the narrower private sharing groups inside a workspace.
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.
POST /v1/workspaces/:workspaceId/checkout returns a URL for completing or retrying workspace payment. It does not itself change the workspace plan until payment completes.
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 add/update accepts a JSON body with userIds and role. Send one user ID or many; every listed user is added to the workspace or has their role updated.
{ "userIds": ["user-id-1", "user-id-2"], "role": "member" }Bulk deletes use a comma-separated userIds query parameter rather than a request body, because some intermediaries strip bodies from DELETE requests.
DELETE /v1/workspaces/:workspaceId/members?userIds=user-id-1,user-id-2
Authorization: Bearer <token>Bulk member calls accept up to 100 user IDs per request.
Workspace membership makes a user available to workspace resources and project membership, but it does not automatically grant access to every project-scoped private pack or track. Add the user to the relevant projects as well.