v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Communication channels

Get all communication channels

Get a list of all communication channels available in the CareCloud platform. Communication channels represent the delivery methods used for customer outreach: email, SMS, web push notifications, mobile app push notifications, Viber, WhatsApp, and White Post. Channel IDs are used when filtering consent records (GET /consents). This endpoint does not require authentication.

get/communication-channels

Query parameters

countinteger

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.

offsetinteger

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_fieldstring

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.

sort_direction'ASC' | 'DESC'

Direction of sorting the response list.

Headers

Accept-Languagestring

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

Response

OK

Example response

{
  "data": {
    "communication_channels": [
      {
        "communication_channel_id": "86e05affc7a7abefcd513ab400",
        "name": "Email",
        "text_id": "email"
      }
    ],
    "total_items": 1
  }
}