---
title: "Lists search views."
method: GET
path: "/search/views"
tags: ["Search"]
---

# Lists search views.

`GET /search/views`

Returns a list of all search views, also known as search filters, matching the given search criteria.<br /> Only search views the logged in user has access to are listed.

## Query parameters

- `offset` integer
- `limit` integer
- `countLimit` integer
- `name` string
- `nameMatchMode` 'START' | 'END' | 'ANYWHERE' | 'EXACT'
- `sortField` 'NAME'
- `sortOrder` 'ASC' | 'DESC'
- `location` string

## Response `200`

The list of returned search views.

- SearchViewPagedResponse
  - `total` integer — The total number of results.
  - `offset` integer — The offset for the results.
  - `limit` integer — The maximum number of results to be returned.
  - `results` SearchView[] — The list of results.
    - `id` string, uuid — The search view ID.
    - `name` string — The search view name.
    - `description` string — Optional search view description.
    - `searchRequest` SearchRequest — The search criteria.
      - `keywords` string — The search term.<br /> The field is mandatory and cannot be empty. You can use optional wildcards and quotes. No asterisk "*" wildcard will be automatically added for REST calls.
      - `searchInFields` SearchInFields[], nullable — Optional set of fields to search in. By default, the search is performed in all the supported fields.
        - `resourceType` string — The reference resource type for the filter, also known as resource category. You must also provide at least one field for each resource type. When you include more than one resource type, you must provide the same fields (if available) for all resource types.<br /> Possible values are `Asset`, `Domain`, `Community`, `User` and `UserGroup`.<br /> Use in conjunction with `fields`.
        - `fields` string[] — A list of fields for the reference resource type. Works in conjunction with `resourceType`.<br /> Possible values for `Asset` are `name`, `displayName`, `comments`, `tags`, `dataClassification` and `attributes`. Note that `attributes` is a wildcard for all attribute types. To search in a specific attribute type, use the following notation: `resource_type:resource_uuid` where `resource_type` is the attribute resource type, such as `StringAttributeType` (or use the generic `attribute`) and `resource_uuid` is the UUID of the attribute type. <br/>Possible values for `Domain` and `Community` are `name` and `comments`.<br /> Possible values for `User` and `UserGroup` are `name`.
      - `filters` SearchFilter[], nullable — Optional filters to apply to narrow down the search results.
        - `field` string — The reference field for the filter. You must also provide at least a value for each reference field.<br /> Possible values are `community`, `domain`, `domainType`, `assetType`, `status`, `createdBy`, `lastModifiedOn`, `createdOn`, `tags`, `certified`, `rating`.<br /> Use in conjunction with `values`.
        - `values` string[] — A list of values for the reference field. You must provide at least one value for each reference filed.<br /> Works in conjunction with `filed`.<br /> <br /> Possible values for `community`, `domain`, `domainType`, `assetType`, `status` and `createdBy` are one or more UUIDs.<br /> <br /> Possible values for `lastModifiedOn` and `createdOn` are `LAST_24H`, `LAST_7D`, `LAST_30D`, `LAST_365D`, `OLDER_THAN_365D`.<br /> <br /> Possible values for `tags` are one or more string values.<br /> <br /> Possible values for `certified` are `true` or `false`.<br /> <br /> Possible values for `rating` are `unrated`, `one_or_more_stars`, `two_or_more_stars`, `three_or_more_stars`, `four_or_more_stars`, `five_stars`.
      - `aggregations` SearchAggregation[], nullable — Optional set of aggregations to perform. Only results that match the search criteria (including all filters) are aggregated. Aggregation counts ignore pagination settings (limit and offset). Aggregations can be used to visualize a faceted search on frontend-related applications.
        - `field` string — The reference field for aggregation. Distinct values of the field are counted in the search results, ignoring pagination, and the top most common are presented in the response.<br /> Possible values are `rootCommunity`, `resourceType`, `assetType`, `domainType`, `status`, `lastModifiedOn`, `createdOn`, `createdBy` and `tags`.
        - `limit` integer, nullable — Optional limit for the number of top aggregated results to return. If not set, the default limit of `10` is used.<br /> The maximum possible value is 1000.
      - `sortField` 'RELEVANCE' | 'NAME' | 'LAST_MODIFIED_ON', nullable — The reference field for sorting the results.
      - `sortOrder` 'ASC' | 'DESC', nullable — The order in which the results are sorted. The default order when sorting by `NAME` is ascending (`ASC`). The default order when sorting by other fields is descending (`DESC`).
      - `highlights` SearchHighlight, nullable — Highlight options for the content that matches the search criteria. If a `preTag` and `postTag` are not specified, the default tags `<B>` and `</B>` are used to enclose the highlighted text. However, the application of these default tags is deprecated. As of the next major version of Collibra Platform, if you define highlighting, you will also need to define the `preTag` and `postTag`.
        - `preTag` string, nullable — Optional string to insert before the highlighted fragment. If set, you must also provide a value for `postTag`.
        - `postTag` string, nullable — Optional string to insert after the highlighted fragment. If set, you must also provide a value for `preTag`.
      - `limit` integer, nullable — The number of search results to present in the response. If set to `0`, only aggregations are performed. Negative values are not possible. If not set, the default limit is used. The maximum possible value is `1000`. In conjunction with `offset`, this field provides a method to paginate the results. The sum of `limit` and `offset` cannot exceed `10000`.
      - `offset` integer, nullable — The number of first search results to skip in the response. Negative values are not possible. If not set or set to `0`, no results are skipped. In conjunction with `limit`, this field provides a method to paginate the results. The sum of `limit` and `offset` cannot exceed `10000`.
      - `product` 'GLOSSARY' | 'CATALOG' | 'ALL', nullable — Optional criteria to apply on PRODUCT property of the document to narrow down the search results.
      - `dataMarketplaceContext` boolean, nullable — Indicates that the search is issued from the Data Marketplace experience.

---

[API](https://skmtc.net/collibra/apis/collibra-data-governance-center-core-api.md) · [All operations](https://skmtc.net/collibra/apis/collibra-data-governance-center-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/collibra/collibra-data-governance-center-core-api/revisions/6d091bc86a33/schema)