Domains - List Domain Workspaces

  • Reference
Service:
Admin
API Version:
v1

Note

This API is in preview.

Returns a list of the workspaces assigned to the specified domain.

This API supports pagination.

Permissions

The caller must be a Fabric administrator.

Required Delegated Scopes

Tenant.Read.All or Tenant.ReadWrite.All.

Limitations

Maximum 25 requests per one minute per principal.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal Yes
Managed identities Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/domains/{domainId}/workspaces
With optional parameters: 
GET https://api.fabric.microsoft.com/v1/admin/domains/{domainId}/workspaces?continuationToken={continuationToken}

URI Parameters

Name In Required Type Description
domainId
 path True

string

uuid

The domain ID.
continuationToken
 query

string

A token for retrieving the next page of results.

Responses

Name Type Description
200 OK

DomainWorkspaces

Request completed successfully.
Other Status Codes

Common error codes:

  • UnknownError - An error occurred.

Examples

Get all domain workspaces example

Sample request

GET https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f/workspaces

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "e281785b-5608-41ac-a1a1-78b48b95b825",
      "displayName": "Mark8ProjectTeam"
    },
    {
      "id": "24402490-9519-48b9-9d51-b2db4095a56b",
      "displayName": "Team southern region"
    },
    {
      "id": "46f8ccd7-a209-4e12-978f-56ef3c44a68c",
      "displayName": "SalesAndMarketing"
    }
  ],
  "continuationToken": null,
  "continuationUri": null
}

Definitions

Name Description
DomainWorkspace

Represents a workspace in a domain.
DomainWorkspaces

A response wrapper for a list of all the workspaces assigned to a domain with a continuous token.

DomainWorkspace

Represents a workspace in a domain.

Name Type Description
displayName

string

The name of the workspace.
id

string

The workspace ID.

DomainWorkspaces

A response wrapper for a list of all the workspaces assigned to a domain with a continuous token.

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.
value

DomainWorkspace[]

The list of all the workspaces assigned to the domain.