API Reference

Channels API

The Channels API allows you to retrieve the communication channels connected to your organization — such as WhatsApp, SMS, LiveChat, or Messenger.

Get all channels in a workspace

get

Returns a list of channels connected to a workspace. Optionally filter by platform or status.

Path parameters

workspacestringRequiredExample: 3df284cf-eb1a-4314-8784-8c5d9b28040c

Query parameters

platformstring · enumOptionalExample: whatsappPossible values:

statusstringOptionalExample: active

Responses

200

Channels retrieved successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Channels retrieved

get

/workspaces/{workspace}/channels

HTTPcURLJavaScriptPython

GET /v1.0/workspaces/{workspace}/channels HTTP/1.1
Host: api.dreams.sa
Accept: */*

200

Channels retrieved successfully

{
  "success": true,
  "message": "Channels retrieved",
  "data": [
    {
      "id": "9ded1284-72b1-40b6-8c96-10c51d4f7926",
      "name": "Channel Arabstock",
      "platform": "whatsapp",
      "status": "active",
      "phone_number": "[phone]"
    }
  ]
}