List workspaces

GET

/api/workspaces

• Production

Returns workspaces accessible to the authenticated user. Owners and admins see all workspaces in the tenant. Agents and observers only see workspaces they are assigned to. Billing users see none.

Authorizations

• bearerAuth

Responses

200

An array of accessible workspaces. May be empty if the user has no workspace assignments.

A list of workspaces accessible to the authenticated user. Agents and observers only see workspaces they are assigned to; owners and admins see all. Each entry is a compact summary; GET /api/workspaces/{workspaceId} returns the full workspace record.

Array<object>

A compact workspace summary returned by the list endpoint. It carries the fields needed to pick a workspace; GET /api/workspaces/{workspaceId} returns the full record.

object

id

required

Unique identifier for the workspace.

string format: uuid

Example

w1a2b3c4-5678-9abc-def0-1234567890ab

name

required

Display name of the workspace.

string

Example

DACH Region

status

required

Lifecycle status of the workspace: active, inactive, or archived.

string

Example

active

brandId

required

The brand this workspace operates under.

string format: uuid

Example

b1a2c3d4-5678-9abc-def0-1234567890ab

brandName

required

Display name of the brand this workspace operates under.

string

Example

Acme

operatingLanguage

required

The primary language the assistant uses when communicating in this workspace. ISO 639-1 code.

string

Example

de