get_workspaces
Retrieve a list of PowerBI workspaces accessible to the service principal. Use this to discover workspace IDs for further operations.
Instructions
Get list of PowerBI workspaces (also called groups) accessible to the service principal.
This tool retrieves all workspaces that the configured service principal has access to. Workspaces are containers for dashboards, reports, datasets, and dataflows in PowerBI.
Use this when you need to:
Discover available workspaces
Find a workspace ID for further operations
List all accessible PowerBI workspaces
Parameters:
top (optional): Maximum number of workspaces to return (1-5000, for pagination)
skip (optional): Number of workspaces to skip (for pagination)
format: Response format - "json" or "markdown" (default: "markdown")
detail: Detail level - "concise" or "detailed" (default: "concise")
Returns: List of workspaces with their IDs, names, and optionally detailed metadata.
Example usage:
Get first 10 workspaces: top=10
Get concise markdown list: format="markdown", detail="concise"
Get detailed JSON: format="json", detail="detailed"
Error handling:
If authentication fails, check your service principal credentials
If no workspaces returned, ensure service principal has workspace access
For permission errors, verify service principal is enabled in PowerBI admin portal
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| top | No | ||
| skip | No | ||
| format | No | markdown | |
| detail | No | concise |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |