Get all customer engagement setups
Get all available setups for customer engagement.
Customer engagement setups define the configuration for the CareCloud JavaScript tracking script, which captures browser-based events on websites and links them to customer profiles. Each setup specifies the tracking behaviour for a particular website or deployment context.
This endpoint does not require authentication. It is typically called by the tracking script during initialisation to load the applicable configuration.
Related: GET /customer-engagement-setups/{customer_engagement_setup_id}
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.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"customer_engagement_setups": [
{
"setup_id": "8bed991c68a470e7aaeffbf048",
"setup": "{\"setup\": [{\"id\": 1,\"name\": \"Setup A\",\"parameters\": {\"param1\": \"value1\",\"param2\": \"value2\"}}]}",
"state": 1
}
],
"total_items": 1
}
}