Skip to main content
GET
Retrieve a workspace group

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organization_id
string
required

The unique identifier of the organization

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$
workspace_group_id
string
required

The unique identifier of the workspace group

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$

Response

Workspace group details retrieved successfully. The response includes the workspace group configuration, type, and location.

id
string
required

ID of the workspace group

Pattern: ^[0-9a-f]{24}$
name
string
required

Name of the workspace group

organization_id
string
required

Organization identifier

Pattern: ^[0-9a-f]{24}$
created_at
string<date-time>
required

Creation timestamp

description
string | null

Description of the workspace group

created_by
string | null

ID of the user who created the workspace group

Pattern: ^[0-9a-f]{24}$
type
enum<string> | null

Type of workspace group

Available options:
static,
dynamic,
entra_id
filter
string | null

Filter string for dynamic workspace groups

location
object | null

Location information of the workspace group

entra_id_source
object | null

Entra ID source information for the workspace group