Edit

Share via

Workspaces - List Workspaces

Service:
Admin
API Version:
v1

Returns a list of workspaces.

Note

This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.

This API supports pagination. A maximum of 10,000 records can be returned per request. With the continuous token provided in the response, you can get the next 10,000 records.

Permissions

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

Required Delegated Scopes

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces
With optional parameters: 
GET https://api.fabric.microsoft.com/v1/admin/workspaces?type={type}&capacityId={capacityId}&name={name}&state={state}&continuationToken={continuationToken}

URI Parameters

Name In Required Type Description
capacityId
 query

string (uuid)

The capacity ID of the workspace.
continuationToken
 query

string

Continuation token. Used to get the next items in the list.
name
 query

string

The workspace name.
state
 query

string

The workspace state. Supported states are active and deleted.
type
 query

string

The workspace type. Supported types are personal, workspace, adminworkspace.

Responses

Name Type Description
200 OK

Workspaces

The operation was successful.
Other Status Codes

ErrorResponse

Common error codes:

  • BadRequest - Query parameters such as workspaceType or workspaceState aren't valid.

  • InsufficientPrivileges - The caller doesn't have permissions to call the API.

Examples

Get a list of workspaces example
Get a list of workspaces using state query parameter example

Get a list of workspaces example

Sample request

GET https://api.fabric.microsoft.com/v1/admin/workspaces

Sample response

Status code:
200 
{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Get a list of workspaces using state query parameter example

Sample request

GET https://api.fabric.microsoft.com/v1/admin/workspaces?state=Active

Sample response

Status code:
200 
{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
Workspace

Workspace.
Workspaces

A list of workspaces.
WorkspaceState

The workspace state. Additional workspace states may be added over time.
WorkspaceType

A workspace type. Additional workspace types may be added over time.

ErrorRelatedResource

Object

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string

ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
relatedResource

ErrorRelatedResource

The error related resource details.

Workspace

Object

Workspace.

Name Type Description
capacityId

string (uuid)

The capacity ID of the workspace.
domainId

string (uuid)

The domain ID of the workspace.
id

string (uuid)

The workspace ID.
name

string

The workspace name.
state

WorkspaceState

The workspace state.
type

WorkspaceType

The workspace type.

Workspaces

Object

A list of workspaces.

Name Type Description
continuationToken

string

The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri

string

The URI of the next result set batch. If there are no more records, it's removed from the response.
workspaces

Workspace[]

The list of fabric workspaces.

WorkspaceState

Enumeration

The workspace state. Additional workspace states may be added over time.

Value Description
Active

The workspace is active. Orphaned workspaces are displayed as active.
Deleted

The workspace is deleted.

WorkspaceType

Enumeration

A workspace type. Additional workspace types may be added over time.

Value Description
Personal

My folder or My workspace used to manage user items.
Workspace

Workspace used to manage the Fabric items.
AdminWorkspace

Admin monitoring workspace. Contains admin reports such as the audit report and the usage and adoption report.