Domains - List Domains (preview)

Service:: Admin

API Version:: v1

Returns info for all domains (preview).

Note

This preview API will be deprecated on March 31, 2026, and replaced by a stable version, available here. The new version introduces breaking changes and is not backward compatible. When calling this API, callers must specify true as the value for the query parameter preview.

Deprecation Notice

A new query parameter preview has been introduced to facilitate this transition:

The preview query parameter currently defaults to true.
Set the value of the preview query parameter to false to use the Release version of this API.
Starting March 31, 2026, the default value for preview will change to false.

It is recommended to migrate your integration to use the Release version as soon as possible by specifying false for the preview query parameter (the default value for the preview query parameter will be set to false on API's deprecation date).

The following incompatible changes were introduced in the Release version:

Response property contributorsScope was removed.

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 and Managed identities	Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/domains?preview={preview}

With optional parameters:

GET https://api.fabric.microsoft.com/v1/admin/domains?nonEmptyOnly={nonEmptyOnly}&preview={preview}

URI Parameters

Name	In	Required	Type	Description
preview	query	True	boolean	This parameter specifies which version of the API to use. Set to `true` to use the preview version described on this page, or to `false` to use the Release version detailed here. Starting March 31, 2026, the default value for `preview` will change to `false`.
nonEmptyOnly	query		boolean	When true, only return domains that have at least one workspace containing an item. Default: false.

Responses

Name	Type	Description
200 OK	DomainsResponsePreview	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: UnknownError - An error occurred.

Name

Type

Description

200 OK

DomainsResponsePreview

Request completed successfully.

Other Status Codes

ErrorResponse

Common error codes:

UnknownError - An error occurred.

Examples

Get all non-empty domains example

Get info for all domains example

Get all non-empty domains example

Sample request

HTTP

GET https://api.fabric.microsoft.com/v1/admin/domains?nonEmptyOnly=True&preview=True

Sample response

Status code:: 200

{
  "domains": [
    {
      "id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "displayName": "Finance",
      "description": "This domain is used for identifying financial data and reports.",
      "parentDomainId": null,
      "contributorsScope": "AdminsOnly"
    },
    {
      "id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
      "displayName": "Human resources",
      "description": "",
      "parentDomainId": null,
      "contributorsScope": "AllTenant"
    },
    {
      "id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
      "displayName": "HR Sales",
      "description": "",
      "parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "contributorsScope": "AllTenant"
    },
    {
      "id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
      "displayName": "Marketing",
      "parentDomainId": null,
      "contributorsScope": "SpecificUsersAndGroups"
    }
  ]
}

Get info for all domains example

Sample request

HTTP

GET https://api.fabric.microsoft.com/v1/admin/domains?preview=True

Sample response

Status code:: 200

{
  "domains": [
    {
      "id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "displayName": "Finance",
      "description": "This domain is used for identifying financial data and reports.",
      "parentDomainId": null,
      "contributorsScope": "AdminsOnly"
    },
    {
      "id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
      "displayName": "Human resources",
      "description": "",
      "parentDomainId": null,
      "contributorsScope": "AllTenant"
    },
    {
      "id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
      "displayName": "HR Sales",
      "description": "",
      "parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "contributorsScope": "AllTenant"
    },
    {
      "id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
      "displayName": "Marketing",
      "parentDomainId": null,
      "contributorsScope": "SpecificUsersAndGroups"
    },
    {
      "id": "17df435d-9efd-48c1-a937-7d6fd70ab26a",
      "displayName": "AdminsOnly",
      "description": "Admins only",
      "parentDomainId": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
      "contributorsScope": "AllTenant"
    },
    {
      "id": "fb765fe3-d404-4f24-9d67-5916449c4c50",
      "displayName": "Root",
      "description": "",
      "parentDomainId": null,
      "contributorsScope": "AllTenant"
    },
    {
      "id": "bda31be4-7efe-4272-8b85-e1b2ff0f0592",
      "displayName": "Legal",
      "description": "This domain is used for identifying legal data and reports.",
      "parentDomainId": null,
      "contributorsScope": "AllTenant"
    }
  ]
}

Definitions

Name	Description
ContributorsScopeType	The contributor scope. Additional contributor scopes may be added over time.
DomainPreview
DomainsResponsePreview	This is a response wrapper for a list of all domains.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.

ContributorsScopeType

Enumeration

The contributor scope. Additional contributor scopes may be added over time.

Value	Description
AllTenant	All the tenant's users.
SpecificUsersAndGroups	Specific users and groups.
AdminsOnly	Tenant and domain admins only.

DomainPreview

Object

Name	Type	Description
contributorsScope	ContributorsScopeType	The domain contributors scope.
description	string	The description of the domain.
displayName	string	The name of the domain.
id	string (uuid)	The domain object ID.
parentDomainId	string (uuid)	The domain parent object ID.

DomainsResponsePreview

Object

This is a response wrapper for a list of all domains.

Name	Type	Description
domains	DomainPreview[]	The list of domains.

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.

Share via

Domains - List Domains (preview)

Deprecation Notice

Permissions

Required Delegated Scopes

Limitations

Microsoft Entra supported identities

Interface

URI Parameters

Responses

Examples

Get all non-empty domains example

Sample request

Sample response

Get info for all domains example

Sample request

Sample response

Definitions

ContributorsScopeType

DomainPreview

DomainsResponsePreview

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails