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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Filter contacts using one or more conditions, combine conditions using and or or, sort the results, paginate the response, or retrieve only the total number of matching contacts.

This is a synchronous API, so the response contains the search results or count directly.

Body Params

audience_type

string

required

Specifies the type of audience in which you want to search.
Allowed values: List | UDT | Segment | CCG

filtering_criteria_operator

string

and | or

Specifies how to combine multiple filtering criteria blocks. (Allowed value "and" & "or"). Mandatory 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.
Each item in filtering_criteria represents a condition block.

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 you want the API to return only the total number of matching records instead of the matching 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.
When 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.

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.