NEnetcorecloud
Contacts

Audience Contact Search

Changed on

The Audience Contact Search API allows you to search for contacts within a specified audience(list, ccg or segment) based on multiple filter conditions.

post/contact/audience/search

Request

  • Base URL
    https://netcoreapi-main-prod-us.netcorein.com/v5
  • URL
    https://netcoreapi-main-prod-us.netcorein.com/v5/contact/audience/search
  • Auth
    API key in header api-key

Headers

api-keystring required

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

Content-Typestring required

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

Request body

audience_typestring required

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

filtering_criteria_operatorstring

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.

get_Countstring

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.

Response

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

request_idstring required

This is unique ID refer to each request.

statusstring required

It signifies the status of API. For example: success , failed.

descriptionstring required

This display the expected description of the API.

codeinteger required

This returns the customized code.

countinteger

The total number of items that match the request's query or filter criteria.

Changes