---
title: "Search Attributes"
method: POST
path: "/client/attribute/search"
tags: ["Attributes"]
---

# Search Attributes

`POST /client/attribute/search`

Searches for custom attributes created for various entities such as user, event, or transaction. You can filter attributes based on entity type, name, or data type. This endpoint supports partial search for attribute names and is useful in UIs that require dynamic attribute lookups or filtering

## Headers

- `api-key` string, required
- `Content-Type` string, required

## Request body

- object
  - `filtering_criteria` object[], required
    - `condition_operator` string
    - `condition_details` object[]
      - `field` string, required
      - `operation` string, required
      - `value` union[], required
        - union
          - string
          - integer
  - `output` object, required
    - `fields` string[], required
    - `get_count` boolean, required
    - `pagination` object, required
      - `page` integer, required
      - `limit` integer, required
    - `sorting` object[], required
      - `field` string
      - `direction` string

## Response `200`

Attributes matching the filters were retrieved successfully

- object
  - `request_id` string, required — Unique request id of the request.
  - `code` 200 | 400 | 401 | 500, required — Response status code indicating the result of the request.
  - `status` 'success' | 'failed', required — Status of the API request.
  - `description` string, required — API response description.
  - `data` object[], required — List of attributes returned in the response.
    - `id` integer — Unique identifier for the attribute.
    - `attribute_code` string — Unique attribute code.
    - `attribute_name` string — Name of the attribute.
    - `attribute_category` string — Category of the attribute.
    - `attribute_type` string — Type of the attribute.
    - `data_type` string — Data type of the attribute (e.g., boolean, string, integer).
    - `masked` boolean — Indicates whether the attribute is masked.
    - `ownerid` integer — ID of the user who created the attribute.
    - `created_at` string — Date and time when the attribute was created.
    - `updated_at` string — Date and time when the attribute was updated.
    - `segmentation` integer — Whether the attribute is used for segmentation.
    - `system_attribute_name` string — Name of the system attribute with which this attribute is mapped.
    - `settings` object — Settings of the attribute.
    - `default_value` string — A brief description of the attribute's purpose.

## Other responses

- `400` — Malformed query or unsupported filter value
- `401` — Unauthorized Access
- `500` — Internal Server Error
- `x-200` — Get Total Counts

---

[API](https://skmtc.net/netcorecloud/apis/contacts-api.md) · [All operations](https://skmtc.net/netcorecloud/apis/contacts-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netcorecloud/contacts-api/versions/2878cfd0ee01/schema)
