---
title: "Get Catalog Search Results"
method: POST
path: "/api/data-governance/v2/catalog/search"
tags: ["Catalog Search V2"]
---

# Get Catalog Search Results

`POST /api/data-governance/v2/catalog/search`

Use this API to retrieve a list of all catalog search results by key terms and filters. The response will include relevant details for each result, including the corresponding data asset ID, name, and the associated tags and terms. This API is designed to return large volumes of catalog search results.

> 🗒 Things to Know
>
> - The `continuationToken` parameter returned in the response can be used on a subsequent API call to retrieve the next set of catalog search results. For more information, see [Understanding & Implementing Pagination](https://developer.onetrust.com/onetrust/reference/understanding-implementing-pagination#request-continuation-based-keyset--cursor-based-pagination).

## Headers

- `x-onetrust-continuationToken` string

## Request body

- DataUseGovernanceDataCatalogMetadataExchangeSearchRequest
  - `searchText` string — Text to search for
  - `filterCriteria` DataUseGovernanceDataCatalogMetadataExchangeFilterCriteria
    - `groupOperator` 'AND' | 'OR', required — Logical operator between criteria groups
    - `criteriaGroups` DataUseGovernanceDataCatalogMetadataExchangeCriteriaGroup[]
      - `operator` 'AND' | 'OR', required — Logical operator between criteria
      - `criteria` DataUseGovernanceDataCatalogMetadataExchangeCriterion[]
        - `searchField` string — Search field name
        - `operator` 'EQ' | 'NOT_EQ' | 'GREATER_THAN' | 'GREATER_THAN_EQUAL_TO' | 'LESS_THAN_EQUAL_TO' | 'AFTER_OR_ON' | 'BEFORE_OR_ON' | 'MORE_THAN' | 'CONTAINS' | 'BETWEEN' | 'WITHIN_THE_LAST' | 'DOES_NOT_CONTAIN' | 'IS_EMPTY' | 'IS_NOT_EMPTY' | 'LIST_CONTAINS' | 'LIST_DOES_NOT_CONTAIN' | 'EQUALS_TO_ANY_OF' | 'NOT_EQUALS_TO_ANY_OF' | 'EQUALS_TO_ALL_OF' | 'NOT_EQUALS_TO_ALL_OF' | 'LIST_CONTAINS_ANY_OF' | 'LIST_DOES_NOT_CONTAIN_ANY_OF', required — Search field operator
        - `value` string — Value for the criterion
        - `values` DataUseGovernanceDataCatalogMetadataExchangeBetweenValue
          - `from` string — Start value for the range
          - `to` string — End value for the range
        - `multiValue` string[]
        - `dateUnitType` 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS' — Unit of date value
        - `searchFieldDataType` string — Data type of the field selected
        - `searchMode` 'ANY' | 'ALL' — Logical operator of the criterion
        - `searchQueryType` 'SIMPLE' | 'FULL' — Query type of the criterion
        - `multiValueRanges` DataUseGovernanceDataCatalogMetadataExchangeBetweenValue[]
          - `from` string — Start value for the range
          - `to` string — End value for the range
  - `searchFields` string[]
  - `facets` string[]
  - `selectFields` string[]
  - `partialSearch` boolean — Whether to perform partial text matching

## Response `200`

OK

- DataUseGovernanceDataCatalogMetadataExchangeExternalSearchResponse
  - `facets` object — Faceted search results grouped by field
  - `documents` DataUseGovernanceDataCatalogMetadataExchangeOneTrustResponseListOTSearchDocument
    - `data` DataUseGovernanceDataCatalogMetadataExchangeOTSearchDocument[] — The parameters that detail entity data.
      - `id` string — Unique identifier of the search document
      - `documentType` string — Type of the search document
      - `name` string — Name of the search document
      - `properties` object
      - `jobId` string — Identifier for the job
      - `source` string — Source of the search document
    - `errors` object[] — This parameter provides error details if 400 Bad Request is returned.
    - `meta` DataUseGovernanceDataCatalogMetadataExchangeOneTrustMetadata
      - `page` DataUseGovernanceDataCatalogMetadataExchangeOneTrustPage
        - `first` boolean — This parameter indicates whether the current page is the first page of the list.
        - `last` boolean — This parameter indicates whether the current page is the last page of the list.
        - `number` integer — The page number of the results.
        - `size` integer — The number of results per page.
        - `totalElements` integer — The total number of results in the list.
        - `totalPages` integer — The total number of pages in the list.
        - `sort` DataUseGovernanceDataCatalogMetadataExchangeOneTrustSort[] — The sort criteria that dictates the order of the results.
          - `direction` 'ASC' | 'DESC' — The order (ASC|DESC) by which results are sorted.
          - `property` string — The criteria by which results are sorted.
  - `continuationToken` string — Token for continuing the search from where it left off

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500` — Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.dev/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/revisions/21de3aa0b170/schema)