Workspaces API

Inspect workspace metadata, settings, and membership lists.

Endpoints

Method	Path	Description
GET	/v1/workspaces/:id	Retrieve basic workspace info (name, slug, icon).
GET	/v1/workspaces/:id/settings	Retrieve branding, policies, analytics, and localization settings.
GET	/v1/workspaces/:id/members	List workspace members with email + role.

All Workspaces endpoints require the workspaces:read scope. The :id path parameter must match the workspace associated with the API key—cross-workspace access returns 403 Access denied.

Key concepts

• Responses are wrapped in { data: ... } for the info/settings endpoints; members returns { data: [...] }.
• Settings include nested objects (branding, support, policies, analytics, localization, taxes) exactly as used by the dashboard.
• Membership listing pulls from both the main database and control plane to resolve roles and email addresses.