v1

latestOpenAPI 3.0.12026-07-2412598.8 KB

Contacts

Search Contacts

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.

post/contact/search

Headers

api-keystring required

Api key for authentication. You must have unique & valid api-key

Content-Typestring required

Specifies the request content type. Must be application/json.

Request body

filtering_criteria_operatorstring

Specify the logical operator to combine multiple filtering criteria.

Example request

{
  "output": {
    "fields": [
      "email",
      "city",
      "guid",
      "mobile",
      "contact_id",
      "FIRST_NAME"
    ]
  }
}

Response

request_idstring required

Unique request id of request.

statusstring required

status of api request (success|failed).

descriptionstring required

Api response description.

codeinteger required

Status code of the API.