API Reference

Get all communication channels

get
https://{project_url}/webservice/rest-api/{api_interface}/{version}/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.

Query Params
integer
≥ 1
Defaults to 100

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.

integer
≥ 0
Defaults to 0

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

string

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.

string
enum

Direction of sorting the response list.

Allowed:
Headers
string
Defaults to cs, en-gb;q=0.8

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

Responses

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 4 days ago

Language
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 days ago