Catalog - Search

Service:

Core

API Version:

v1

The Catalog Search API enables programmatic discovery of OneLake catalog entries across workspaces. It supports cross-workspace search over catalog metadata and returns results filtered to entries the calling principal is authorized to access. Search results include stable identifiers that are intended to be used with complementary Fabric APIs to retrieve additional details or perform supported actions.

Note

Catalog search is currently in Preview (learn more).

A CatalogEntry is a discoverable metadata representation of a Microsoft Fabric entity, currently scoped to workspace items. Catalog entries are intended for metadata discovery only and do not grant access to underlying data or item content.

Permissions

The caller can only discover catalog entries for workspaces and items that the caller is authorized to access.

Required Delegated Scopes

Catalog.Read.All

Limitations

• continuationToken must not be combined with search or filter. The token already carries those values from the originating request.

• pageSize must be between 1 and 1000.

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

POST https://api.fabric.microsoft.com/v1/catalog/search

Request Body

Name	Type	Description
continuationToken	string	The continuation token for the next page. A continuation token carries forward the search, filter, and pageSize of the original request, so it may be sent on its own. It must not be combined with search or filter in the same request; doing so returns an error.
filter	string	The filter for the search. Additional filter options may be added over time. The filter parameter supports the following properties: Type: Matches the type property of a catalog entry, for example Report, Lakehouse, or Workspace. A single filter can specify at most 500 Type values, each up to 50 characters long. WorkspaceId: The ID of the workspace that contains the catalog entry. A single filter can specify at most 12 WorkspaceId values, each of which must be a valid GUID. The filter parameter supports the following operators to refine results: eq: Equals; matches the exact value. ne: Not Equals; excludes the specified value. and: Logical AND; matches only if all of the conditions are true. or: Logical OR; matches if any of the conditions are true. ( ): Parentheses; groups expressions to define logical hierarchy.
pageSize	integer	The page size that needs to be returned. Page size must be between 1 and 1000. Defaults to 50.
search	string	The text query for the search. This field supports searching across the display name, workspace display name, and description of the CatalogEntry. The search field supports the following operators: " " : Double quotes; match the enclosed words as an exact phrase. * : Asterisk; wildcard matching zero or more characters. ? : Question mark; wildcard matching a single character. && : Double ampersands; require every search term. Underscores are treated as part of a search term; no escaping is required. Other special characters are ignored and treated as separators.

Responses

Name	Type	Description
200 OK	CatalogQueryResponse	OK
429 Too Many Requests	ErrorResponse	The service rate limit was exceeded. The server returns a Retry-After header indicating, in seconds, how long the client must wait before sending additional requests. Headers Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: InvalidRequest - The request body was not provided, or is otherwise invalid. InvalidSearch - The search value could not be parsed. InvalidFilter - The filter could not be parsed, or a filter value is malformed or exceeds its maximum length. InvalidFilterProperty - The filter references a property that is not supported. FilterTooManyValues - The filter specifies more values for a property than that property allows. FilterNotSupported - Filtering is not supported. ConflictingFilterParameters - continuationToken was combined with search or filter. InvalidPageSize - pageSize is outside the range 1 to 1000. InvalidContinuationToken - The continuationToken is not valid. ContinuationTokenTooLong - The continuationToken exceeds the maximum length. TypeNotFound - The filter references an item type that does not exist. Unauthorized - Missing or invalid authentication Internal Server Error - Unexpected service failure.

Examples

Search example

Search within a workspace example

Search example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/catalog/search

{
  "search": "sales",
  "pageSize": 3,
  "filter": "Type eq 'Report' or Type eq 'Lakehouse' or Type eq 'Workspace'"
}

Sample response

Status code:

200

{
  "value": [
    {
      "id": "0acd697c-1550-43cd-b998-91bfb12347c6",
      "type": "Report",
      "catalogEntryType": "FabricItem",
      "displayName": "Monthly Sales Revenue",
      "description": "Consolidated revenue report for the current fiscal year.",
      "hierarchy": {
        "workspace": {
          "id": "7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3",
          "displayName": "Sales Analytics"
        }
      }
    },
    {
      "id": "5e8f2a1b-9c3d-4e7f-b6a5-d4c3b2a1e0f9",
      "type": "Lakehouse",
      "catalogEntryType": "FabricItem",
      "displayName": "Sales Revenue Lakehouse",
      "description": "Central lakehouse for sales transaction data.",
      "hierarchy": {
        "workspace": {
          "id": "a2b3c4d5-e6f7-4a8b-9c0d-1e2f3a4b5c6d",
          "displayName": "Finance Platform"
        }
      }
    },
    {
      "id": "7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3",
      "type": "Workspace",
      "catalogEntryType": "Workspace",
      "displayName": "Sales Analytics",
      "description": "Workspace for the sales analytics team."
    }
  ],
  "continuationToken": "eyJza2lwIjozLCJ0YWtl..."
}

Search within a workspace example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/catalog/search

{
  "search": "revenue",
  "filter": "(Type eq 'Report' or Type eq 'SemanticModel') and WorkspaceId eq '7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3'",
  "pageSize": 2
}

Sample response

Status code:

200

{
  "value": [
    {
      "id": "0acd697c-1550-43cd-b998-91bfb12347c6",
      "type": "Report",
      "catalogEntryType": "FabricItem",
      "displayName": "Monthly Sales Revenue",
      "description": "Consolidated revenue report for the current fiscal year.",
      "hierarchy": {
        "workspace": {
          "id": "7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3",
          "displayName": "Sales Analytics"
        }
      }
    },
    {
      "id": "c41d9f2e-7b60-4a15-8d3c-2f6e9a0b7c48",
      "type": "SemanticModel",
      "catalogEntryType": "FabricItem",
      "displayName": "Revenue Semantic Model",
      "description": "Shared revenue model backing the sales reports.",
      "hierarchy": {
        "workspace": {
          "id": "7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3",
          "displayName": "Sales Analytics"
        }
      }
    }
  ],
  "continuationToken": "eyJza2lwIjoyLCJ0YWtl..."
}

Definitions

Name	Description
CatalogEntryType	The catalog entry type. Additional CatalogEntryType types may be added over time.
CatalogQueryRequest	The query for the search.
CatalogQueryResponse	The results of the search.
CatalogWorkspace	The workspace for the catalog entry.
ErrorParameter	A structured parameter providing additional machine-readable context about an error.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ItemCatalogEntry	The catalog metadata representation of a Fabric item.
ItemCatalogEntryHierarchy	The immediate ancestors of the item in Fabric's data architecture. Only applicable levels are returned.
ItemType	The type of the item. Additional item types may be added over time.
WorkspaceCatalogEntry	The catalog metadata representation of a Fabric workspace.
WorkspaceCatalogEntryType	The type reported on a workspace catalog entry. Additional WorkspaceCatalogEntryType types may be added over time.

CatalogEntryType

Enumeration

The catalog entry type. Additional CatalogEntryType types may be added over time.

Value	Description
FabricItem	A Fabric item catalog entry type.
Workspace	A workspace catalog entry type.

CatalogQueryRequest

Object

The query for the search.

Name	Type	Description
continuationToken	string	The continuation token for the next page. A continuation token carries forward the search, filter, and pageSize of the original request, so it may be sent on its own. It must not be combined with search or filter in the same request; doing so returns an error.
filter	string	The filter for the search. Additional filter options may be added over time. The filter parameter supports the following properties: Type: Matches the type property of a catalog entry, for example Report, Lakehouse, or Workspace. A single filter can specify at most 500 Type values, each up to 50 characters long. WorkspaceId: The ID of the workspace that contains the catalog entry. A single filter can specify at most 12 WorkspaceId values, each of which must be a valid GUID. The filter parameter supports the following operators to refine results: eq: Equals; matches the exact value. ne: Not Equals; excludes the specified value. and: Logical AND; matches only if all of the conditions are true. or: Logical OR; matches if any of the conditions are true. ( ): Parentheses; groups expressions to define logical hierarchy.
pageSize	integer	The page size that needs to be returned. Page size must be between 1 and 1000. Defaults to 50.
search	string	The text query for the search. This field supports searching across the display name, workspace display name, and description of the CatalogEntry. The search field supports the following operators: " " : Double quotes; match the enclosed words as an exact phrase. * : Asterisk; wildcard matching zero or more characters. ? : Question mark; wildcard matching a single character. && : Double ampersands; require every search term. Underscores are treated as part of a search term; no escaping is required. Other special characters are ignored and treated as separators.

CatalogQueryResponse

Object

The results of the search.

Name	Type	Description
continuationToken	string	The continuationToken for the next page.
value	CatalogEntry[]: ItemCatalogEntry[] WorkspaceCatalogEntry[]	A list of catalog entries

CatalogWorkspace

Object

The workspace for the catalog entry.

Name	Type	Description
displayName	string	The display name of the workspace.
id	string (uuid)	The ID of the workspace.

ErrorParameter

Object

A structured parameter providing additional machine-readable context about an error.

Name	Type	Description
message	string	A human-readable description of the parameter's meaning.
name	string	The parameter identifier.
value	string	The parameter value.

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.
isRetriable	boolean	When true, the request can be retried. Use the Retry-After response header to determine the delay, if available.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
parameters	ErrorParameter[]	Structured parameters providing additional machine-readable context about the error.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string (uuid)	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.
parameters	ErrorParameter[]	Structured parameters providing additional machine-readable context about the error.
relatedResource	ErrorRelatedResource	The error related resource details.

ItemCatalogEntry

Object

The catalog metadata representation of a Fabric item.

Name	Type	Description
catalogEntryType	string: FabricItem	The catalog entry type.
description	string	The description of the catalog entry.
displayName	string	The catalog entry display name.
hierarchy	ItemCatalogEntryHierarchy	The hierarchy of the catalog entry.
id	string (uuid)	The objectId of the catalog entry.
type	ItemType	The Fabric item type.

ItemCatalogEntryHierarchy

Object

The immediate ancestors of the item in Fabric's data architecture. Only applicable levels are returned.

Name	Type	Description
workspace	CatalogWorkspace	The workspace that contains the item.

ItemType

Enumeration

The type of the item. Additional item types may be added over time.

Value	Description
Dashboard	PowerBI dashboard.
Report	PowerBI report.
SemanticModel	PowerBI semantic model.
PaginatedReport	PowerBI paginated report.
Datamart	PowerBI datamart.
Lakehouse	A lakehouse.
Eventhouse	An eventhouse.
Environment	An environment.
KQLDatabase	A KQL database.
KQLQueryset	A KQL queryset.
KQLDashboard	A KQL dashboard.
DataPipeline	A data pipeline.
Notebook	A notebook.
SparkJobDefinition	A spark job definition.
MLExperiment	A machine learning experiment.
MLModel	A machine learning model.
Warehouse	A warehouse.
Eventstream	An eventstream.
SQLEndpoint	An SQL endpoint.
MirroredWarehouse	A mirrored warehouse.
MirroredDatabase	A mirrored database.
Reflex	A Reflex.
GraphQLApi	An API for GraphQL item.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	A Copy job.
VariableLibrary	A VariableLibrary.
Dataflow	A Dataflow.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	A Warehouse snapshot.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	A Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	A mirrored azure databricks catalog.
Map	A Map.
AnomalyDetector	An Anomaly Detector.
UserDataFunction	A User Data Function.
GraphModel	A GraphModel.
GraphQuerySet	A Graph QuerySet.
SnowflakeDatabase	A Snowflake Database to store Iceberg tables created from Snowflake account.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	A Cosmos DB Database.
Ontology	An Ontology.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.
MirroredCatalog	A MirroredCatalog.
AppBackend	An AppBackend.
OrgApp	An Org App.
OrgAppAudience	An Org App Audience.
DataBuildToolJob	A DataBuildToolJob.
AzureDatabricksStorage	A OneLake-backed storage item for Azure Databricks.
Plan	A plan.

WorkspaceCatalogEntry

Object

The catalog metadata representation of a Fabric workspace.

Name	Type	Description
catalogEntryType	string: Workspace	The catalog entry type.
description	string	The description of the catalog entry.
displayName	string	The catalog entry display name.
id	string (uuid)	The objectId of the catalog entry.
type	WorkspaceCatalogEntryType	The catalog entry type. Always Workspace for workspace catalog entries.

WorkspaceCatalogEntryType

Enumeration

The type reported on a workspace catalog entry. Additional WorkspaceCatalogEntryType types may be added over time.

Value	Description
Workspace	A workspace.