Skip to main content
GET
List your workspaces
The response groups memberships by tenant_id and includes each group’s numeric id and role. Use the group ID as X-VOAI-ORGANIZATION-ID; the tenant ID and public workspace identifier are different identifiers. With an API key, this request itself requires a valid workspace header.

Authorizations

Authorization
string
header
required

Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs super_user role.

Headers

X-VOAI-ORGANIZATION-ID
string | null

Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace ID to access. The key owner must be a current member. Missing or invalid IDs return 400; non-member workspaces return 403. Not required for bearer authentication, which uses the user's selected workspace.

Response

Successful Response

groups
GroupInfo · object[]
required
public_id
string | null
tenant_id
integer | null
tenant_name
string | null