Skip to main content
cancel
Showing results for 
Search instead for 
Did you mean: 

July 7 - July 17 | Round 2 of the Power BI Dataviz World Championships. Don't miss your chance! Learn more

Reply
jstearnes
Advocate I
Advocate I

GET workspaces

I am developing a REST API and I need to retrieve a list of workspaces but I cannot find such a resource in the documentation - https://msdn.microsoft.com/en-us/library/mt147898.aspx. I have, however, seen a workspaces resource documented in the embedded API - https://msdn.microsoft.com/en-us/library/azure/mt711496.aspx, this resource requires a workspaceCollectionName parameter to be supplied, of which I do not know where to retrieve. I am not currently using this API, nor do I understand why there is a separate API to the regular one. Can anyone help?

3 REPLIES 3
v-ljerr-msft
Microsoft Employee
Microsoft Employee

Hi @jstearnes,



I am developing a REST API and I need to retrieve a list of workspaces but I cannot find such a resource in the documentation - https://msdn.microsoft.com/en-us/library/mt147898.aspx


You should be able to use the  Get Groups operation returns a JSON list of all groups that the signed in user is a member of. Groups are a collection of unified Azure Active Directory groups that the user is a member of and is available in the Power BI service. These are referred to as app workspaces within the Power BI service.



I have, however, seen a workspaces resource documented in the embedded API - https://msdn.microsoft.com/en-us/library/azure/mt711496.aspx, this resource requires a workspaceCollectionName parameter to be supplied, of which I do not know where to retrieve. I am not currently using this API, nor do I understand why there is a separate API to the regular one. Can anyone help?

The workspace collection name is contained in app token which is used for all embedding requests. And there are methods available within the SDKs that make creation of app tokens easier. For example, for .NET you can look at the Microsoft.PowerBI.Security.PowerBIToken class and the CreateReportEmbedToken methods. For the .NET SDK, you can refer to Scopes. For more details, you can refer to Authenticating and authorizing with Power BI Workspace CollectionsSmiley Happy

 

Regards

Hi @v-ljerr-msft I am using Java and am not using any SDKs. Also, I do not believe that groups are resources because I have one workspace, 'My Workspace', but when I call GET groups an empty collection is returned

Hi @v-ljerr-msft any additional help would be greatly appreciated

Helpful resources

Announcements
FabCon and SQLCon Barcelona 2026

FabCon & SQLCon – Barcelona 2026

Join us in Barcelona for FabCon and SQLCon, the Fabric, Power BI, SQL, and AI community event. Save €200 with code FABCMTY200.

60 days of Data Days Carousel

Data Days 2026

Join Fabric Data Days 2026: 60 days of free live/on-demand sessions, challenges, study groups, and certification opportunities.

Power BI DataViz World Championships carousel

Power BI DataViz World Championships - June 2026

A new Power BI DataViz World Championship is coming this June! Don't miss out on submitting your entry.