Skip to main content
Version: Next

CatalogClient.queryEntities()

Home > @backstage/catalog-client > CatalogClient > queryEntities

Gets paginated entities from the catalog.

Signature:

queryEntities(request?: QueryEntitiesRequest, options?: CatalogRequestOptions): Promise<QueryEntitiesResponse>;

Parameters

Parameter

Type

Description

request

QueryEntitiesRequest

(Optional) Request parameters

options

CatalogRequestOptions

(Optional) Additional options

**Returns:**

Promise<QueryEntitiesResponse>

Remarks