# Power BI Admin API

**Canonical:** https://apis.io/apis/power-bi/power-bi-admin-api/  
**Provider:** Power BI — https://apis.io/providers/power-bi/  
**Base URL:** https://api.powerbi.com  
**Documentation:** https://learn.microsoft.com/en-us/rest/api/power-bi/

Power BI Admin API is one of 37 APIs that [Power BI](https://apis.io/providers/power-bi/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Admin. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

The Admin API from Power BI — 55 operation(s) for admin.

## Operations (59)

| Method | Path | Summary |
|---|---|---|
| POST | `/v1.0/myorg/admin/workspaces/getInfo` | Initiates a call to receive metadata for the requested list of workspaces |
| GET | `/v1.0/myorg/admin/workspaces/scanStatus/{scanId}` | Gets the scan status for the specified scan |
| GET | `/v1.0/myorg/admin/workspaces/scanResult/{scanId}` | Gets the scan result for the specified scan |
| GET | `/v1.0/myorg/admin/workspaces/modified` | Gets a list of workspace IDs in the organization |
| POST | `/v1.0/myorg/admin/capacities/AssignWorkspaces` | Assigns the specified workspaces to the specified Premium capacity |
| POST | `/v1.0/myorg/admin/capacities/UnassignWorkspaces` | Unassigns the specified workspaces from capacity |
| GET | `/v1.0/myorg/admin/datasets` | Returns a list of datasets for the organization |
| GET | `/v1.0/myorg/admin/datasets/{datasetId}/datasources` | Returns a list of data sources for the specified dataset |
| GET | `/v1.0/myorg/admin/datasets/{datasetId}/users` | Returns a list of users that have access to the specified dataset |
| GET | `/v1.0/myorg/admin/groups` | Returns a list of workspaces for the organization |
| GET | `/v1.0/myorg/admin/groups/{groupId}` | Returns a workspace for the organization |
| PATCH | `/v1.0/myorg/admin/groups/{groupId}` | Updates the properties of the specified workspace |
| GET | `/v1.0/myorg/admin/groups/{groupId}/users` | Returns a list of users that have access to the specified workspace |
| POST | `/v1.0/myorg/admin/groups/{groupId}/users` | Grants user permissions to the specified workspace |
| DELETE | `/v1.0/myorg/admin/groups/{groupId}/users/{user}` | Removes user permissions from the specified workspace |
| POST | `/v1.0/myorg/admin/groups/{groupId}/restore` | Restores a deleted workspace |
| GET | `/v1.0/myorg/admin/groups/{groupId}/dataflows/{dataflowId}/upstreamDataflows` | Returns a list of upstream dataflows for the specified dataflow |
| GET | `/v1.0/myorg/admin/groups/{groupId}/dashboards` | Returns a list of dashboards from the specified workspace |
| GET | `/v1.0/myorg/admin/groups/{groupId}/reports` | Returns a list of reports from the specified workspace |
| GET | `/v1.0/myorg/admin/groups/{groupId}/datasets` | Returns a list of datasets from the specified workspace |
| GET | `/v1.0/myorg/admin/groups/{groupId}/datasets/upstreamDataflows` | Returns a list of upstream dataflows for datasets from the specified workspace |
| GET | `/v1.0/myorg/admin/groups/{groupId}/dataflows` | Returns a list of dataflows from the specified workspace |
| GET | `/v1.0/myorg/admin/groups/{groupId}/unused` | Returns a list of datasets, reports, and dashboards that have not been used… |
| GET | `/v1.0/myorg/admin/reports` | Returns a list of reports for the organization |
| GET | `/v1.0/myorg/admin/reports/{reportId}/users` | Returns a list of users that have access to the specified report |
| GET | `/v1.0/myorg/admin/reports/{reportId}/subscriptions` | Returns a list of report subscriptions along with subscriber details. |
| GET | `/v1.0/myorg/admin/dashboards` | Returns a list of dashboards for the organization |
| GET | `/v1.0/myorg/admin/dashboards/{dashboardId}/tiles` | Returns a list of tiles within the specified dashboard |
| GET | `/v1.0/myorg/admin/dashboards/{dashboardId}/users` | Returns a list of users that have access to the specified dashboard |
| GET | `/v1.0/myorg/admin/dashboards/{dashboardId}/subscriptions` | Returns a list of dashboard subscriptions along with subscriber details. |
| GET | `/v1.0/myorg/admin/widelySharedArtifacts/linksSharedToWholeOrganization` | Returns a list of Power BI reports that are shared with the whole organization… |
| GET | `/v1.0/myorg/admin/widelySharedArtifacts/publishedToWeb` | Returns a list of Power BI items (such as reports or dashboards) that are… |
| GET | `/v1.0/myorg/admin/imports` | Returns a list of imports for the organization |
| POST | `/v1.0/myorg/admin/tenantKeys` | Adds an encryption key for Power BI workspaces assigned to a capacity |
| GET | `/v1.0/myorg/admin/tenantKeys` | Returns the encryption keys for the tenant |
| POST | `/v1.0/myorg/admin/tenantKeys/{tenantKeyId}/Default.Rotate` | Rotate the encryption key for Power BI workspaces assigned to a capacity |
| GET | `/v1.0/myorg/admin/capacities` | Returns a list of capacities for the organization |
| PATCH | `/v1.0/myorg/admin/capacities/{capacityId}` | Changes specific capacity information. |
| GET | `/v1.0/myorg/admin/capacities/{capacityId}/users` | Returns a list of users that have access to the specified workspace |
| GET | `/v1.0/myorg/admin/capacities/refreshables` | Returns a list of refreshables for the organization within a capacity |
| GET | `/v1.0/myorg/admin/capacities/{capacityId}/refreshables` | Returns a list of refreshables for the specified capacity that the user has… |
| GET | `/v1.0/myorg/admin/capacities/{capacityId}/refreshables/{refreshableId}` | Returns the specified refreshable for the specified capacity that the user has… |
| GET | `/v1.0/myorg/admin/dataflows` | Returns a list of dataflows for the organization |
| GET | `/v1.0/myorg/admin/dataflows/{dataflowId}/export` | Exports the definition for the specified dataflow to a JSON file |
| GET | `/v1.0/myorg/admin/dataflows/{dataflowId}/datasources` | Returns a list of data sources for the specified dataflow |
| GET | `/v1.0/myorg/admin/dataflows/{dataflowId}/users` | Returns a list of users that have access to the specified dataflow |
| GET | `/v1.0/myorg/admin/apps` | Returns a list of apps in the organization |
| GET | `/v1.0/myorg/admin/apps/{appId}/users` | Returns a list of users that have access to the specified app |
| GET | `/v1.0/myorg/admin/users/{userId}/artifactAccess` | Returns a list of Power BI items (such as reports or dashboards) that the… |
| GET | `/v1.0/myorg/admin/users/{userId}/subscriptions` | Returns a list of subscriptions for the specified user. |
| GET | `/v1.0/myorg/admin/activityevents` | Returns a list of audit activity events for a tenant |
| POST | `/v1.0/myorg/admin/informationprotection/removeLabels` | Remove sensitivity labels from Power BI items (such as reports or dashboards)… |
| POST | `/v1.0/myorg/admin/informationprotection/setLabels` | Set sensitivity labels on Power BI items (such as reports or dashboards) by… |
| GET | `/v1.0/myorg/admin/pipelines` | Returns a list of deployment pipelines for the organization |
| GET | `/v1.0/myorg/admin/pipelines/{pipelineId}/users` | Returns a list of users that have access to a specified deployment pipeline |
| POST | `/v1.0/myorg/admin/pipelines/{pipelineId}/users` | Grants user permissions to a specified deployment pipeline |
| DELETE | `/v1.0/myorg/admin/pipelines/{pipelineId}/users/{identifier}` | Removes user permissions from a specified deployment pipeline |
| GET | `/v1.0/myorg/admin/profiles` | Returns a list of service principal profiles for the organization |
| DELETE | `/v1.0/myorg/admin/profiles/{profileId}` | Deletes the specified service principal profile |

## Machine-readable artifacts (2)

- **OpenAPI** — https://artifacts.apis.io/power-bi/openapi/power-bi-admin-api-openapi.yml
- **Documentation** — https://learn.microsoft.com/en-us/rest/api/power-bi/

## Other Power BI APIs (12)

- [Power BI Authoring MCP Server](https://apis.io/apis/power-bi/power-bi-authoring-mcp-server/)
- [Power BI Consumption MCP Server](https://apis.io/apis/power-bi/power-bi-consumption-mcp-server/)
- [Power BI Embedded](https://apis.io/apis/power-bi/power-bi-embedded/)
- [Power BI Management API](https://apis.io/apis/power-bi/power-bi-management-api/)
- [Power BI Push Datasets API](https://apis.io/apis/power-bi/power-bi-push-datasets-api/)
- [Power BI Report Server REST API](https://apis.io/apis/power-bi/power-bi-report-server-rest-api/)
- [Power BI Visuals API](https://apis.io/apis/power-bi/power-bi-visuals-api/)
- [Power BI Dashboards API](https://apis.io/apis/power-bi/power-bi-dashboards-api/)
- [Power BI Datasets API](https://apis.io/apis/power-bi/power-bi-datasets-api/)
- [Power BI Gateways API](https://apis.io/apis/power-bi/power-bi-gateways-api/)
- [Power BI Groups API](https://apis.io/apis/power-bi/power-bi-groups-api/)
- [Power BI Imports API](https://apis.io/apis/power-bi/power-bi-imports-api/)

## Tags

Admin

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/power-bi/power-bi-admin-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/power-bi/.