GroupList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/power-bi/json-schema/power-bi-group-list-schema.json",
  "title": "GroupList",
  "description": "A list of Power BI workspaces",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/power-bi-groups-api-openapi.yml#/components/schemas/GroupList",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Group"
      }
    },
    "@odata.context": {
      "type": "string"
    }
  },
  "$defs": {
    "Group": {
      "type": "object",
      "description": "A Power BI workspace (group)",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The unique identifier of the workspace"
        },
        "name": {
          "type": "string",
          "description": "The display name of the workspace"
        },
        "isReadOnly": {
          "type": "boolean",
          "description": "Whether the workspace is read-only"
        },
        "isOnDedicatedCapacity": {
          "type": "boolean",
          "description": "Whether the workspace is on a dedicated capacity"
        },
        "capacityId": {
          "type": "string",
          "format": "uuid",
          "description": "The capacity ID if on a dedicated capacity"
        },
        "type": {
          "type": "string",
          "description": "The workspace type",
          "enum": [
            "Workspace",
            "Group",
            "PersonalGroup"
          ]
        },
        "state": {
          "type": "string",
          "description": "The workspace state",
          "enum": [
            "Active",
            "Deleted",
            "Removing"
          ]
        }
      }
    }
  }
}