---
title: "Search Contacts"
method: POST
path: "/contact/search"
tags: ["Contacts"]
---

# Search Contacts

`POST /contact/search`

The Search Contacts (Sync) API retrieves contact details based on advanced filtering conditions. It supports real-time search with sorting, pagination, and the ability to return either a count or detailed contact information.

## Headers

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

## Request body

- object
  - `filtering_criteria` object[], required — Array of filtering criteria. Defines filtering conditions based on contact fields or attributes.
    - `condition_operator` string — Define condition operator for selecting contacts. (supported "and" & "or"). Required when more than one conditions are provided in the 'condition_details' array. All values of 'condition_operator' in every 'filtering_criteria' array must be same and it should be different from 'filtering_criteria_operator'.
    - `condition_details` object[], required — Array of condition details based on contact fields or attribute.
      - `field_category` string, required — Specify field category to be added in filter condition.
      - `field` string, required — Defines filtering conditons based on contact fields or attribute. The values in this field must belong to the field category.
      - `operation` string, required — Specifies the comparison operator.
      - `value` union[], required — An array of values used for filtering against the specified field.
        - union
          - integer
          - string
  - `filtering_criteria_operator` string — Specify the logical operator to combine multiple filtering criteria.
  - `output` object, required — Select whether to return only the count or the full contact details. When requesting contact details, specify sorting, pagination, and which fields to include in the response.
    - `get_count` boolean — Use this field to get total count of records. If true, API returns only the count of matching result. If false, API return objects of filtered records. If null, value will be set to false by default.
    - `sorting` object[] — Specify sorting parameters. An array of sorting rules applied in the order they are declared. These will be ignored if get_count is set to true.
      - `field` string, required — This field will be used for Sorting.
      - `direction` string, required — The direction of the sort, either asc for ascending or desc for descending.
    - `pagination` object — Specify pagination parameters (page and limit). Default is page 1 and limit 10. Ignored if get_count is set to true.
      - `page` integer, required — specify page number, Default value is 1
      - `limit` integer, required — specify page limit. Default value is 10
    - `fields` string[], required — These contact fields will be included in the response. COntact attributes and/ or audience details can be requested. Example : contact_id Email, Mobile, City

## Response `200`

- object
  - `request_id` string, required — Unique request id of request.
  - `status` string, required — status of api request (success|failed).
  - `description` string, required — Api response description.
  - `code` integer, required — Status code of the API.
  - `data` object[] — This consist array of search list Contact Details.
    - `contact_id` integer
    - `EMAIL` string
    - `MOBILE` string
    - `CITY` string

## Other responses

- `400`
- `401`
- `x-200-2`

---

[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)