Audience Contact Search

post

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

The Audience Contact Search API allows you to search for contacts within a specified audience(list, ccg or UDT) based on multiple filter conditions. It supports advanced filtering logic, sorting, pagination, and the ability to fetch either result data or just the count of matching records. This is a synchronous API.

Body Params

audience_type

string

required

Specifies the audience type.
Allowed values: List | UDT | Segment | CCG

filtering_criteria_operator

string

Specifies how to combine multiple filtering criteria blocks. (Allowed value "and" & "or"). Mandory if more than one 'filtering_criteria' block is provided. Blank value accepted if exactly one 'filtering_criteria' block is provided.

filtering_criteria

array of objects

required

Defines the conditions used to filter contacts within the specified audience.

filtering_criteria*

output

object

required

Defines how the results should be returned. Required unless 'get_Count' is set to 'true'.

get_Count

string

Specifies whether the API should return only thr total count of matching records instead of the full contact data. If 'get_Count' is set to 'true', the response will include only the count. If set to 'false', the output object must be defined.
Important Notes
When 'get_Count' is 'true', fields like 'pagination','fields, and 'sorting' under the 'output' object are ignored./nWhen using this mode, the API returns the total number of matched records as an integer.

Headers

api-key

string

required

API key for authentication. You must have a unique and valid API key.

Content-Type

string

required

Specify the request content type. It must be application/json

Responses

200Success Response: The request was successfully processed and matching audience contact data or count was returned.

401Unauthorized: The API key is missing, invalid, or the request lacks proper authentication.

500Internal Server Error: An unexpected issue occurred while processing the request.