---
title: "Get all customer engagement setups"
method: GET
path: "/customer-engagement-setups"
tags: ["Customer engagement"]
---

# Get all customer engagement setups

`GET /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}](https://carecloud.readme.io/reference/getcustomerengagementsetup)

## Query parameters

- `count` integer
- `offset` integer
- `sort_field` string
- `sort_direction` 'ASC' | 'DESC'

## Headers

- `Accept-Language` string

## Response `200`

OK

- object
  - `data` object
    - `customer_engagement_setups` CustomerEngagementSetup[] — List of all setups.
      - `setup_id` string — The unique ID of the customer engagement setup.
      - `setup` string — Serialized JSON contains the customer engagement setup for the application
      - `state` 0 | 1 | 2 — State of the customer engagement setup. *Possible values are: 0 - deleted / 1 - active / 2 - non active*
    - `total_items` integer — The number of all found setups.

## Other responses

- `400` — Bad input parameter. The response body's `error.error_data.invalid_params[]` array lists the parameters that caused the failure, each carrying a `reason` code. See the `BadRequestErrorBody` schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.
- `403` — The client does not exist or the client tried to access an unauthorized property or resource.
- `404` — The resource was not found.
- `405` — The resource does not support the specified HTTP method.
- `429` — Too many requests - more than the resource limit.
- `500` — Server is not working as expected.
- `503` — Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

---

[API](https://skmtc.net/crmcarecloud/apis/rest-api-reference.md) · [All operations](https://skmtc.net/crmcarecloud/apis/rest-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crmcarecloud/rest-api-reference/revisions/329c06dbf8d9/schema)
