Admin - WorkspaceInfo GetModifiedWorkspaces

  • Reference
Service:
Power BI REST APIs
API Version:
v1.0

Gets a list of workspace IDs in the organization.

If the optional modifiedSince parameter is set to a date-time, only the IDs of workspaces that changed after that date-time are returned. If the modifiedSince parameter isn't used, the IDs of all workspaces in the organization are returned. The date-time specified by the modifiedSince parameter must be in the range of 30 minutes (to allow workspace changes to take effect) to 30 days prior to the current time.

Permissions

The user must be a Fabric administrator or authenticate using a service principal.

When running under service principal authentication, an app must not have any admin-consent required permissions for Power BI set on it in the Azure portal.

Required Scope

Tenant.Read.All or Tenant.ReadWrite.All

Relevant only when authenticating via a standard delegated admin access token. Must not be present when authentication via a service principal is used.

Limitations

Maximum 30 requests per hour. 

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/modified
With optional parameters: 
GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/modified?modifiedSince={modifiedSince}&excludePersonalWorkspaces={excludePersonalWorkspaces}&excludeInActiveWorkspaces={excludeInActiveWorkspaces}

URI Parameters

Name In Required Type Description
excludeInActiveWorkspaces
 query

boolean

Whether to exclude inactive workspaces
excludePersonalWorkspaces
 query

boolean

Whether to exclude personal workspaces
modifiedSince
 query

string

date-time

Last modified date (must be in ISO 8601 compliant UTC format)

Responses

Name Type Description
200 OK

ModifiedWorkspace[]

OK

Examples

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/modified?modifiedSince=2020-10-02T05:51:30.0000000Z&excludePersonalWorkspaces=True&excludeInActiveWorkspaces=True

Sample response

Status code:
200 
[
  {
    "id": "3740504d-1f93-42f9-8e9d-c8ba9b787a3b"
  },
  {
    "id": "19cb346c-9839-4e19-81e6-76364d0b836f"
  }
]

Definitions

ModifiedWorkspace

A modified workspace

Name Type Description
id

string

The workspace object ID