Search Contacts

post

https://netcoreapi-main-prod-us.netcorein.com/v5/contact/search

The Search Contacts (Sync) API retrieves contact details based on advanced filtering conditions.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Use the Search Contacts API to find contacts in Netcore CE based on one or more conditions.

You can search contacts using contact fields, attributes, or audience information.
Combine multiple conditions using and or or.
Return the matching contacts or only the total number of matching contacts.
Choose which contact fields or attributes to return.
Sort the results.
Paginate through the results.

The Search Contacts API is synchronous, which means the API processes the request and returns the search results in the response. The OpenAPI describes it as a real-time search API.

Body Params

All necessary parameters should be passed in the request body in JSON format. Click '+' icon to enter a value for each parameter

filtering_criteria

array of objects

required

It defines the conditions that determine which contacts should be returned by the Search API. For example, search for contacts whose first name is John, contacts belonging to a particular list, or contacts whose email matches a particular value.

filtering_criteria*

filtering_criteria_operator

string

and | or

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.

Headers

api-key

string

required

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

Responses

200Success. The request was processed successfully and the matching contact data was returned.

400Bad Request: The request could not be processed because it contains invalid or missing parameters, filtering criteria, field values, or other request data.

401Unautorized: Authentication failed because the API key is missing or invalid. Provide a valid API key and try again.