Get all audiences
Get a list of all audiences available in CareCloud. An audience is a group of customers defined as a target group of an omnichannel campaign. Audiences are built by filtering customer data - including demographics, purchase history, campaign responses, consent preferences, and activity events - to define the exact segment to be targeted.
⚠️ Endpoint is available only in the Enterprise interface.
Query parameters
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.
Direction of sorting the response list.
Search record by name or a part of the name.
The unique ID of the communication channel. List of values is available in resource GET /communication-channels.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"audiences": [
{
"audience_id": "8bed991c68a470e7aaeffbf048",
"name": "Newsletter subscribers",
"communication_channel_id": "8bed991c68a470e7aaeffbf048",
"state": 1,
"last_change": "2019-07-15 17:26:34",
"created_by": "8bed991c68a470e7aaeffbf048",
"updated_by": "8bed991c68a470e7aaeffbf048"
}
],
"total_items": 1
}
}