ConnectCloud Developers

Channels of the tenant (comms:read)

GET /api/comms/v1/channels

Module: Comms · operationId: listChannels · Tag: Channels · Auth: access token (Authorization: Bearer <accessToken>)

Responses

  • 200 Channels (application/json)

Fields of the 200 answer:

  • items (array of Channel): The tenant's channels
    • config (object): The kind's public configuration. Kind teams (read-only): teamName, channelName and conversationType (channel or groupChat); the conversation's Teams ids stay in comms.
    • createdAt (string (date-time)): Creation time
    • createdBy (string): Who created the channel
    • id (string (uuid)): Channel id
    • isDefault (boolean): The tenant's default e-mail channel
    • kind (string): Channel kind (see ChannelKind.kind)
    • lastCheckAt (string (date-time)): Time of the last connection test
    • lastCheckOk (boolean): Result of the last connection test
    • lastError (string): Error of the last connection test
    • medium (string): push is the platform channel that fans out to the devices of a person (ADR 0043); no caller routes to it (one of email, webhook, teams, push)
    • name (string): Display name
    • rev (integer): Revision for optimistic locking (send it back as rev)
    • secrets (object): Which secret fields are set; values are never returned
    • status (string): active channels send; disabled ones do not (one of active, disabled)
    • updatedAt (string (date-time)): Time of the last change

Example 200 answer:

{
  "items": [
    {
      "config": {
        "format": "teams_card"
      },
      "createdAt": "2026-09-03T14:05:11Z",
      "createdBy": "sophie.huber@muster-it.example",
      "id": "9c4e2b7a-1d3f-4a6b-8c5d-2e7f9a1b3c4d",
      "isDefault": false,
      "kind": "webhook",
      "lastCheckAt": "2026-11-16T08:12:40Z",
      "lastCheckOk": true,
      "medium": "webhook",
      "name": "Teams-Kanal Service Desk",
      "rev": 2,
      "secrets": {
        "signingSecret": true,
        "url": true
      },
      "status": "active",
      "updatedAt": "2026-11-16T08:12:40Z"
    }
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/comms/v1/channels' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI