v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Customer engagement

Get a customer engagement setup

Get information about a specific customer engagement setup.

Returns the full configuration of a single customer engagement setup, which defines the tracking behaviour for a specific deployment of the CareCloud JavaScript tracking script. When a visitor is identified (for example, after login), events captured by the script are linked to the corresponding customer profile.

This endpoint does not require authentication. To retrieve all available setups, use GET /customer-engagement-setups.

get/customer-engagement-setups/{customer_engagement_setup_id}

Path parameters

customer_engagement_setup_idstring required

The unique ID of the customer engagement setup.

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

OK

Example response

{
  "data": {
    "setup_id": "8bed991c68a470e7aaeffbf048",
    "setup": "{\"setup\": [{\"id\": 1,\"name\": \"Setup A\",\"parameters\": {\"param1\": \"value1\",\"param2\": \"value2\"}}]}",
    "state": 1
  }
}