---
title: "Search by Attribute"
method: GET
path: "/catalog/v1/search/attribute"
tags: ["Search (v1)"]
---

# Search by Attribute

`GET /catalog/v1/search/attribute`

[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)

Retrieve data for the specified attribute search query.

## Query parameters

- `type` string[]
- `attr` string[]
- `attrName` string[]
- `attrValuePrefix` string[]
- `tag` string
- `sortBy` string
- `sortOrder` 'ASCENDING' | 'DESCENDING'
- `deleted` boolean
- `limit` integer
- `offset` integer

## Response `200`

On successful search query with some results, might return an empty list if execution succeeded without any results

- SearchResult
  - `searchParameters` SearchParams — Search paramas to filter results
    - `includeDeleted` boolean — Whether to include deleted
    - `limit` integer — The limit
    - `offset` integer — The offset
  - `types` string[] — The types
  - `entities` EntityHeader[] — The entities
    - `typeName` string — The type name
    - `attributes` object — The attributes
    - `guid` string — The internal guid
    - `status` 'ACTIVE' | 'DELETED' | 'PURGED' — The status
    - `displayText` string — The display text
    - `classificationNames` string[] — The classification (tag) names
    - `classifications` Classification[] — The classifications (tags)
      - `typeName` string — The tag name
      - `attributes` object — The tag attributes
      - `entityGuid` string — The internal entity guid
      - `entityStatus` 'ACTIVE' | 'DELETED' | 'PURGED' — The entity status
      - `propagate` boolean — Whether to propagate the tag
      - `validityPeriods` TimeBoundary[] — The validity periods
        - `startTime` string — The start time of format yyyy/MM/dd HH:mm:ss
        - `endTime` string — The end time of format yyyy/MM/dd HH:mm:ss
        - `timeZone` string — The time zone (see java.util.TimeZone)
      - `removePropagationsOnEntityDelete` boolean — Whether to remove propagations on entity delete
    - `meaningNames` string[] — The meaning names
    - `meanings` TermAssignmentHeader[] — The meanings
      - `termGuid` string — The term guid
      - `relationGuid` string — The relation guid
      - `description` string — The description
      - `displayText` string — The display text
      - `expression` string — The expression
      - `createdBy` string — The creator
      - `steward` string — The steward
      - `source` string — The source
      - `confidence` integer — The confidence
      - `status` 'DISCOVERED' | 'PROPOSED' | 'IMPORTED' | 'VALIDATED' | 'DEPRECATED' | 'OBSOLETE' | 'OTHER' — The status
    - `isIncomplete` boolean — Whether is incomplete
    - `labels` string[] — The labels
  - `referredEntities` object — The referred entities

## Other responses

- `400` — Invalid wildcard or query parameters
- `429` — Rate Limit Error
- `500` — Internal Server Error

---

[API](https://skmtc.dev/confluent/apis/confluent-cloud-apis.md) · [All operations](https://skmtc.dev/confluent/apis/confluent-cloud-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/confluent/confluent-cloud-apis/revisions/a6a73f98a698/schema)