Power BI

Power BI Groups API

Manage workspaces (groups) including listing, creating, deleting, and managing workspace users. Workspaces are containers for dashboards, reports, datasets, and dataflows.

GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /groups List workspaces I can access · Power Bi List Workspaces #
Ask an LLM
“Which Power BI workspaces do I have access to?”
“Can I filter workspaces by name or page through a long list?”
Tell an agent
List all my workspaces.
List workspaces matching {filter}.
POST /groups Create a workspace · Power Bi Create a Workspace #
Ask an LLM
“How do I create a new workspace for my team?”
“Can I set up a fresh workspace just by giving it a name?”
Tell an agent
Create a workspace named {name}.
Set up a new team workspace called {name}.
DELETE /groups/{groupId} Delete a workspace · Power Bi Delete a Workspace #
Ask an LLM
“How do I delete a workspace I no longer need?”
“Does deleting a workspace permanently remove its reports, dashboards and datasets?”
Tell an agent destructive · confirm first
Delete workspace {groupId}.
Permanently remove workspace {groupId} and everything in it.
GET /groups/{groupId}/users List a workspace's members · Power Bi List Workspace Users #
Ask an LLM
“Who has access to a particular workspace?”
“What access rights does each member of a workspace have?”
Tell an agent
List the users of workspace {groupId}.
Show who can access workspace {groupId} and their roles.
POST /groups/{groupId}/users Add a user to a workspace · Power Bi Add a Workspace User #
Ask an LLM
“How do I give a colleague access to a workspace?”
“Can I add someone to a workspace as a Viewer instead of a Member?”
Tell an agent
Add {emailAddress} to workspace {groupId} as {groupUserAccessRight}.
Give {emailAddress} {groupUserAccessRight} rights in the {groupId} workspace.
PUT /groups/{groupId}/users/{userId} Change a workspace member's access right · Power Bi Update Workspace User Access #
Ask an LLM
“How do I promote an existing workspace member from Contributor to Admin?”
“Can I change the role of someone already in a workspace?”
Tell an agent
Change {userId} ({emailAddress}) in workspace {groupId} to {groupUserAccessRight}.
Update existing member {emailAddress} in workspace {groupId} to access right {groupUserAccessRight}, user ID {userId}.
DELETE /groups/{groupId}/users/{userId} Remove a user from a workspace · Power Bi Remove a Workspace User #
Ask an LLM
“How do I revoke someone's access to a workspace?”
“Can I remove a former teammate from a workspace?”
Tell an agent destructive · confirm first
Remove {userId} from workspace {groupId}.
Revoke all of {userId}'s access to workspace {groupId}.
GET /groups/{groupId}/datasets List datasets in a workspace · Power Bi List Datasets in a Workspace #
Ask an LLM
“Which datasets are in a shared team workspace?”
“Can I list datasets for a workspace other than My Workspace?”
Tell an agent
List the datasets in workspace {groupId}.
Show all datasets inside the {groupId} workspace.
GET /groups/{groupId}/reports List reports in a workspace · Power Bi List Reports in a Workspace #
Ask an LLM
“Which reports are in a shared team workspace?”
“Can I get embed info for every report in one workspace?”
Tell an agent
List the reports in workspace {groupId}.
Show all reports inside the {groupId} workspace.
GET /groups/{groupId}/dashboards List dashboards in a workspace · Power Bi List Dashboards in a Workspace #
Ask an LLM
“Which dashboards live in a shared workspace rather than My Workspace?”
“Can I list the dashboards of one team workspace?”
Tell an agent
List the dashboards in workspace {groupId}.
Show all dashboards inside the {groupId} workspace.
GET /groups/{groupId}/imports List imports in a workspace · Power Bi List Imports in a Workspace #
Ask an LLM
“Did my PBIX upload to a workspace finish importing?”
“What content has been imported into a workspace, and with what status?”
Tell an agent
List the imports in workspace {groupId}.
Show the status of recent imports into workspace {groupId}.
POST /groups/{groupId}/imports Import a PBIX or Excel file into a workspace · Power Bi Import Content Into a Workspace #
Ask an LLM
“How do I upload a PBIX file into a workspace?”
“Can I import an Excel workbook and decide what happens if the dataset name already exists?”
Tell an agent
Import {file} into workspace {groupId} as dataset {datasetDisplayName}.
Upload {file} to workspace {groupId} named {datasetDisplayName}, using {nameConflict} on a name clash.

Documentation

📖
Documentation
https://docs.microsoft.com/en-us/rest/api/power-bi/
📖
Authentication
https://docs.microsoft.com/en-us/power-bi/developer/embedded/get-azuread-access-token
📖
GettingStarted
https://docs.microsoft.com/en-us/power-bi/developer/embedded/embedding-content
📖
RateLimits
https://docs.microsoft.com/en-us/power-bi/developer/automation/api-rest-api-limitations
📖
Troubleshooting
https://learn.microsoft.com/en-us/power-bi/developer/embedded/troubleshoot-rest-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/power-bi/refs/heads/main/openapi/power-bi-groups-api-openapi.yml

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/power-bi/refs/heads/main/json-ld/power-bi-rest-context.jsonld
🔗
SDKs
https://docs.microsoft.com/en-us/javascript/api/overview/powerbi/
🔗
ChangeLog
https://docs.microsoft.com/en-us/power-bi/developer/embedded/embedded-analytics-power-bi-changelog

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/power-bi:power-bi-groups-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

power-bi-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Power BI REST Groups API
  description: The Power BI REST API provides service endpoints for embedding, administration, governance, and user resources. It enables programmatic access to Power BI content including datasets, reports, dashboards, and workspaces (groups). The API uses Azure Active Directory (OAuth 2.0) for authentication and authorization.
  version: '1.0'
  contact:
    name: Microsoft Power BI Support
    url: https://powerbi.microsoft.com/en-us/support/
  termsOfService: https://powerbi.microsoft.com/en-us/api-terms/
  license:
    name: Microsoft API License
    url: https://powerbi.microsoft.com/en-us/terms-of-service/
servers:
- url: https://api.powerbi.com/v1.0/myorg
  description: Power BI REST API - User context
security:
- bearerAuth: []
tags:


# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/power-bi/refs/heads/main/openapi/power-bi-groups-api-openapi.yml