Skip to main content

​
Workspaces API

Workspace endpoints control tenancy, team access, and workspace-level settings.

​
Authentication model

  • Requires authenticated user context.
  • Many membership/invite/API-key operations are session-only (API-key auth is explicitly blocked).

​
Endpoint matrix

​
Core workspace lifecycle

  • GET /workspaces
  • POST /workspaces
  • GET /workspaces/:workspaceId
  • PATCH /workspaces/:workspaceId
  • DELETE /workspaces/:workspaceId

​
Team and roles

  • GET /workspaces/:workspaceId/members
  • POST /workspaces/:workspaceId/members/invite
  • PATCH /workspaces/:workspaceId/members/:memberId
  • DELETE /workspaces/:workspaceId/members/:memberId
  • POST /workspaces/:workspaceId/transfer-ownership

​
Invitations

  • GET /workspaces/invitations/pending
  • POST /workspaces/invitations/:token/accept
  • DELETE /workspaces/invitations/:invitationId

​
API keys and usage helpers

  • GET /workspaces/:workspaceId/api-keys
  • POST /workspaces/:workspaceId/api-keys
  • PUT /workspaces/:workspaceId/api-keys/:keyId
  • DELETE /workspaces/:workspaceId/api-keys/:keyId
  • GET /workspaces/:workspaceId/usage
  • GET /workspaces/:workspaceId/billing

​
Permission families

  • workspace:read, workspace:update
  • members:read, members:invite, members:update_roles, members:remove
  • billing:read
  • api_keys:* for key lifecycle
  • owner-only protections on destructive actions (workspace delete, ownership transfer)

​
Plan/limit gates

  • Maximum joined workspaces per user is enforced.
  • API key creation/update/delete is feature-gated by API access entitlement.
  • Invite creation is rate-limited and can return limit responses.

​
Operational notes

  • /workspaces/:workspaceId/billing is a legacy helper; full billing flows are under /billing/*.
  • Ownership transfer performs strict membership/role safety checks.
  • Invitation acceptance verifies limits and workspace access constraints.

​
Typical failures

  • 400 invalid role transition / ownership transfer constraints
  • 403 permission denied or plan feature unavailable
  • 404 workspace/member/invitation not found
  • 409 invitation/member state conflicts
Related docs:
  • /api-reference/workspaces/members-invitations-and-ownership
  • /api-reference/workspaces/api-keys-usage-and-billing
  • /user-guides/manual/workspace/workspaces-and-access
  • /user-guides/manual/workspace/workspace-settings-and-governance-reference